Changes 2025.10.23

What's New

The following APIs have been added for the support of AppKeys in TrustX. The APIs below are introduced as Early Access.

DELETE /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/registrations/keyIds/{keyId}

POST /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/deregistrations

POST /api/identity-store/stores/{storeName}/appkeys/authentications

GET /api/identity-store/stores/{storeName}/users/{userId}/appkeys

DELETE /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/preferredDevice/{deviceId}

POST /api/identity-store/stores/{storeName}/users/{userExtId}/appkeys/relyingParties/{rpId}/authentications/{authPolicyName}/ext

DELETE /api/identity-store/stores/{storeName}/users/{userId}/appkeys/devices/{id}

POST /api/identity-store/stores/{storeName}/appkeys/relyingParties/{rpId}/authentications/{authPolicyName}

GET /api/identity-store/stores/{storeName}/users/{userId}/appkeys/{id}/registrationAudit

GET /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/{id}/ext

DELETE /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/{id}/ext

POST /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/preferredDevices/ext

DELETE /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/preferredDevice/{deviceId}/ext

GET /api/identity-store/stores/{storeName}/appkeyConfig/{rpId}

POST /api/identity-store/stores/{storeName}/appkeyConfig/{rpId}

DELETE /api/identity-store/stores/{storeName}/appkeyConfig/{rpId}

GET /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/{id}/registrationAudit/ext

POST /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/preferredDevices

POST /api/identity-store/stores/{storeName}/appkeys/authentications/sessions/{sessionId}

GET /api/identity-store/stores/{storeName}/users/{userId}/appkeys/{id}

POST /api/identity-store/stores/{storeName}/users/{userId}/appkeys/{id}

DELETE /api/identity-store/stores/{storeName}/users/{userId}/appkeys/{id}

POST /api/identity-store/stores/{storeName}/appkeyConfig

POST /api/identity-store/stores/{storeName}/users/{userExtId}/appkeys/relyingParties/{rpId}/registrations/{regPolicyName}/ext

DELETE /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/devices/{id}/ext

POST /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/authentications/{authPolicyName}

DELETE /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/registrations/keyIds/{keyId}/ext

POST /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/relyingParties/{rpId}/deregistrations/ext

POST /api/identity-store/stores/{storeName}/appkeys/registrations/sessions/{sessionId}

POST /api/identity-store/stores/{storeName}/users/{userId}/appkeys/relyingParties/{rpId}/registrations/{regPolicyName}

POST /api/identity-store/stores/{storeName}/appkeys/registrations

GET /api/identity-store/stores/{storeName}/users/{extUserId}/appkeys/ext

POST /api/identity-store/stores/{storeName}/appkeys/relyingParties/{rpId}/registrations/{regPolicyName}

POST /api/identity-store/stores/{storeName}/users/{userExtId}/appkeys/{id}/ext

What's Changed

GET /api/process-manager/processInstances/{processInstanceId}

This API remains backwards compatible.

Return Type:

Changed response : 200 OK

• Changed content type : application/json
• Added property externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

GET /api/process-manager/processInstances/{processInstanceId}/withParameters

This API remains backwards compatible.

Return Type:

Changed response : 200 OK

• Changed content type : application/json
• Added property externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

POST /api/process-manager/processInstances/create

This API remains backwards compatible.

Return Type:

Changed response : 201 Created

• Changed content type : application/json
• Added property externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

GET /api/process-manager/processTokens/{processTokenId}

This API remains backwards compatible.

Return Type:

Changed response : 200 OK

• Changed content type : application/json
• Added property processInstanceInit.externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

PUT /api/process-manager/processTokens/{processTokenId}

This API remains backwards compatible.

Return Type:

Changed response : 200 OK

• Changed content type : application/json
• Added property processInstanceInit.externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

GET /api/process-manager/processInstances

This API remains backwards compatible.

Return Type:

Changed response : 200 OK

• Changed content type : application/json
• Added property processInstanceInit.externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

POST /api/process-manager/processTokens

This API remains backwards compatible.

Return Type:

Changed response : 201 Created

• Changed content type : application/json
• Added property processInstanceInit.externalSources.documentUploads (object) > External Document Uploads. This is a map based on a doc key and the upload.

GET /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdata

There are differences in the OpenAPI spec of the getUserData API. The API remains backwards compatible. Changes are because of improved automation for the automated generation of the getUserData API documentation. The changes ensure that a more comprehensive API response structure is provided.

Parameters:

Added: optimized in query. Set to true to get an optimized response that excludes large data, such as images. Defaults to false.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

• Added property for previously undocumented properties

  • Added property customPages (object)
  • Added property keyedAdditionalDocuments (object)
  • Added property watchlists (array)

• Additional properties have been documented for other properties of the response.

GET /api/identity-store/stores

This API is still marked as Early Access. Changes have been made to improve this API's performance. The data returned has been updated to remove configuration JSON from the response.

Return Type:

Changed response : 200 OK

• Changed content type : application/json
• Changed property tenant (object) to tenantId (string) ren The id of the tenant in which this store resides.
• Deleted property configuration (object) > Identity Store configuration settings. Contains global settings, user locking configuration and policies for face, appkey and passkey registration and authentication