 
curl --request POST \ --url 'https://myTenantId.fir.trustx.com/api/arthr/apiKeys/issue' \ --header 'X-ApiKey: {X-ApiKey}' \ --header 'X-Api-Key: {X-Api-Key}' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

object	object
token	string
ttl	int32

400

Bad Request

401

Unauthorized

Response

 
{ "token": "{string}", "ttl": "{int32}"}
Copy

List API Keys for the tenant

List API Keys for the tenant.

API Permissions: TNT#{tenantid}#ArthrServer:listTenantApiKeys

Auth

Query String

name	string	Default: %
page	integer	Default: 0
size	integer	minimum: 1 Default: 10
sort	object
sort	array[string]

GET /api/arthr/apiKeys

 
curl --get \ --url 'https://myTenantId.fir.trustx.com/api/arthr/apiKeys' \ --header 'Authorization: Bearer {token}' \ --data name=%25 \ --data page={page} \ --data size=10 \ --data sort=%7B%22sort%22:%5B%22%7Barray%5Bstring%5D...%7D%22%5D%7D
Copy

Responses

200

object	object
totalElements	int64
totalPages	int32
first	boolean
number	int32
sort	array[object]
direction	string
nullHandling	string
ascending	boolean
property	string
ignoreCase	boolean
last	boolean
numberOfElements	int32
pageable	object
sort	array[object]
direction	string
nullHandling	string
ascending	boolean
property	string
ignoreCase	boolean
unpaged	boolean
paged	boolean
pageSize	int32
pageNumber	int32
offset	int64
size	int32
content	array[object]
permittedOperations	array[string]
createdDtm	date-time
lastUpdatedDtm	date-time
createdBy	string
lastUpdatedBy	string
id	string
type	string	Enum: `PERMANENT`,`SESSION`
code	string
name	string	maxLength: 255 minLength: 1
description	string	maxLength: 255 minLength: 0
status	string	Enum: `ACTIVE`,`BLOCKED`,`ARCHIVED`
permissions	array[string]
expiringDtm	date-time
empty	boolean

400

Bad Request

401

Unauthorized

Response

 
{ "totalElements": "{int64}", "totalPages": "{int32}", "first": "{boolean}", "number": "{int32}", "sort": [  {   "direction": "{string}",   "nullHandling": "{string}",   "ascending": "{boolean}",   "property": "{string}",   "ignoreCase": "{boolean}"  } ], "last": "{boolean}", "numberOfElements": "{int32}", "pageable": {  "sort": [   {    "direction": "{string}",    "nullHandling": "{string}",    "ascending": "{boolean}",    "property": "{string}",    "ignoreCase": "{boolean}"   }  ],  "unpaged": "{boolean}",  "paged": "{boolean}",  "pageSize": "{int32}",  "pageNumber": "{int32}",  "offset": "{int64}" }, "size": "{int32}", "content": [  {   "permittedOperations": [    "{array[string]...}"   ],   "createdDtm": "{date-time}",   "lastUpdatedDtm": "{date-time}",   "createdBy": "{string}",   "lastUpdatedBy": "{string}",   "id": "{string}",   "type": "{string}",   "code": "{string}",   "name": "{string}",   "description": "{string}",   "status": "{string}",   "permissions": [    "{array[string]...}"   ],   "expiringDtm": "{date-time}"  } ], "empty": "{boolean}"}
Copy

Create an API Key for a tenant

Create an API Key for a tenant.

API Permissions: TNT#{tenantid}#ArthrServer:createTenantApiKey

Auth

Request Body

object	object
permittedOperations	array[string]
createdDtm	date-time
lastUpdatedDtm	date-time
createdBy	string
lastUpdatedBy	string
id	string
type	string	Enum: `PERMANENT`,`SESSION`
code	string
name	string	maxLength: 255 minLength: 1
description	string	maxLength: 255 minLength: 0
status	string	Enum: `ACTIVE`,`BLOCKED`,`ARCHIVED`
permissions	array[string]
expiringDtm	date-time

POST /api/arthr/apiKeys

 
curl --request POST \ --url 'https://myTenantId.fir.trustx.com/api/arthr/apiKeys' \ --header 'Authorization: Bearer {token}' \ --data '{  "permittedOperations": [    "{array[string]...}"  ],  "createdDtm": "{date-time}",  "lastUpdatedDtm": "{date-time}",  "createdBy": "{string}",  "lastUpdatedBy": "{string}",  "id": "{string}",  "type": "{string}",  "code": "{string}",  "name": "{string}",  "description": "{string}",  "status": "{string}",  "permissions": [    "{array[string]...}"  ],  "expiringDtm": "{date-time}"}'
Copy

Responses

201

Created

object	object
permittedOperations	array[string]
createdDtm	date-time
lastUpdatedDtm	date-time
createdBy	string
lastUpdatedBy	string
id	string
type	string	Enum: `PERMANENT`,`SESSION`
code	string
name	string	maxLength: 255 minLength: 1
description	string	maxLength: 255 minLength: 0
status	string	Enum: `ACTIVE`,`BLOCKED`,`ARCHIVED`
permissions	array[string]
expiringDtm	date-time

400

Bad Request

401

Unauthorized

Response

 
{ "permittedOperations": [  "{array[string]...}" ], "createdDtm": "{date-time}", "lastUpdatedDtm": "{date-time}", "createdBy": "{string}", "lastUpdatedBy": "{string}", "id": "{string}", "type": "{string}", "code": "{string}", "name": "{string}", "description": "{string}", "status": "{string}", "permissions": [  "{array[string]...}" ], "expiringDtm": "{date-time}"}
Copy

Get an API Key for a tenant

Returns the specific API Key for a tenant.

API Permissions: TNT#{tenantid}#ArthrServer:getFromTenant

Auth

Path Params

apiKeyId string

GET /api/arthr/apiKeys/{apiKeyId}

 
curl --get \ --url 'https://myTenantId.fir.trustx.com/api/arthr/apiKeys/{apiKeyId}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
permittedOperations	array[string]
createdDtm	date-time
lastUpdatedDtm	date-time
createdBy	string
lastUpdatedBy	string
id	string
type	string	Enum: `PERMANENT`,`SESSION`
code	string
name	string	maxLength: 255 minLength: 1
description	string	maxLength: 255 minLength: 0
status	string	Enum: `ACTIVE`,`BLOCKED`,`ARCHIVED`
permissions	array[string]
expiringDtm	date-time

400

Bad Request

401

Unauthorized

Response

 
{ "permittedOperations": [  "{array[string]...}" ], "createdDtm": "{date-time}", "lastUpdatedDtm": "{date-time}", "createdBy": "{string}", "lastUpdatedBy": "{string}", "id": "{string}", "type": "{string}", "code": "{string}", "name": "{string}", "description": "{string}", "status": "{string}", "permissions": [  "{array[string]...}" ], "expiringDtm": "{date-time}"}
Copy

Update an API Key for a tenant

Updates an API Key for a tenant.

API Permissions: TNT#{tenantid}#ArthrServer:updateTenantApiKey

Auth

Path Params

apiKeyId string

Request Body

object	object
permittedOperations	array[string]
createdDtm	date-time
lastUpdatedDtm	date-time
createdBy	string
lastUpdatedBy	string
id	string
type	string	Enum: `PERMANENT`,`SESSION`
code	string
name	string	maxLength: 255 minLength: 1
description	string	maxLength: 255 minLength: 0
status	string	Enum: `ACTIVE`,`BLOCKED`,`ARCHIVED`
permissions	array[string]
expiringDtm	date-time

POST /api/arthr/apiKeys/{apiKeyId}

 
curl --request POST \ --url 'https://myTenantId.fir.trustx.com/api/arthr/apiKeys/{apiKeyId}' \ --header 'Authorization: Bearer {token}' \ --data '{  "permittedOperations": [    "{array[string]...}"  ],  "createdDtm": "{date-time}",  "lastUpdatedDtm": "{date-time}",  "createdBy": "{string}",  "lastUpdatedBy": "{string}",  "id": "{string}",  "type": "{string}",  "code": "{string}",  "name": "{string}",  "description": "{string}",  "status": "{string}",  "permissions": [    "{array[string]...}"  ],  "expiringDtm": "{date-time}"}'
Copy

Responses

200

object	object
permittedOperations	array[string]
createdDtm	date-time
lastUpdatedDtm	date-time
createdBy	string
lastUpdatedBy	string
id	string
type	string	Enum: `PERMANENT`,`SESSION`
code	string
name	string	maxLength: 255 minLength: 1
description	string	maxLength: 255 minLength: 0
status	string	Enum: `ACTIVE`,`BLOCKED`,`ARCHIVED`
permissions	array[string]
expiringDtm	date-time

400

Bad Request

401

Unauthorized

Response

 
{ "permittedOperations": [  "{array[string]...}" ], "createdDtm": "{date-time}", "lastUpdatedDtm": "{date-time}", "createdBy": "{string}", "lastUpdatedBy": "{string}", "id": "{string}", "type": "{string}", "code": "{string}", "name": "{string}", "description": "{string}", "status": "{string}", "permissions": [  "{array[string]...}" ], "expiringDtm": "{date-time}"}
Copy

Delete an API Key.

Deletes the specific API Key. Once the API is deleted it cannot be recovered.

API Permissions: TNT#{tenantid}#ArthrServer:deleteFromTenant

Auth

Path Params

apiKeyId string

DELETE /api/arthr/apiKeys/{apiKeyId}

 
curl --request DELETE \ --url 'https://myTenantId.fir.trustx.com/api/arthr/apiKeys/{apiKeyId}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

204

No Content

No response body

400

Bad Request

401

Unauthorized

Response

 
No response
Copy

Admin Sessions

Endpoints

GET

/api/arthr/oidcSessions/{sessionId}/sessionId

GET

/api/arthr/oidcSessions

GET

/api/arthr/oidcSessions/{id}

Show

Process Instance

Endpoints

POST

/api/process-server/processes/{processDefinitionName}/businessKeys/{businessKey}/topicName/{topicName}/continue

POST

/api/process-server/startProcess

Show

Process Tokens

Endpoints

GET

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

PUT

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

DELETE

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

GET

/api/process-manager/processTokens

POST

/api/process-manager/processTokens

Show

Process Definition Tags

Endpoints

GET

/api/process-manager/processDefinitions/tags

DELETE

/api/process-manager/processDefinitions/tags/{name}

POST

/api/process-manager/processDefinitions/{processDefinitionId}/tags

Show

Process Instances

Endpoints

GET

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

DELETE

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

GET

/api/process-manager/processInstances

POST

/api/process-manager/processInstances

POST

/api/process-manager/processInstances/csv

POST

/api/process-manager/processInstances/byIds

GET

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

POST

/api/process-manager/processInstances/create

GET

/api/process-manager/processInstances/search

Show

Audits

Endpoints

GET

/api/metrics-server/auditMessages/queries/{executionId}/status

POST

/api/metrics-server/auditMessages/queries/start

GET

/api/metrics-server/auditMessages/queries/{executionId}/result

Show

Userdata-controller

Endpoints

GET

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

GET

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

GET

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

POST

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

Show

Custom Pages

Endpoints

GET

/api/theme-server/customPages

POST

/api/theme-server/customPages

GET

/api/theme-server/customPages/{name}/{version}

POST

/api/theme-server/customPages/previews

POST

/api/theme-server/customPages/{id}/status/{status}

DELETE

/api/theme-server/customPages/{id}/archive

GET

/api/theme-server/customPages/{id}

POST

/api/theme-server/customPages/{id}

DELETE

/api/theme-server/customPages/{id}

GET

/api/theme-server/customPages/{name}/versions

Show

Watchlist V2

Endpoints

GET

/api/watchlist-manager/watchlists/{watchlistId}

POST

/api/watchlist-manager/watchlists/{watchlistId}

DELETE

/api/watchlist-manager/watchlists/{watchlistId}

GET

/api/watchlist-manager/watchlists/usage/largest

GET

/api/watchlist-manager/watchlists/{watchlistId}/usage

GET

/api/watchlist-manager/watchlists

POST

/api/watchlist-manager/watchlists

GET

/api/watchlist-manager/watchlists/usage

POST

/api/watchlist-manager/watchlists/{watchlistId}/queries

Show

Trends

Endpoints

GET

/api/watchlist-manager/trends

POST

/api/watchlist-manager/trends

DELETE

/api/watchlist-manager/trends/processInstances/{processInstanceId}

GET

/api/watchlist-manager/trends/processInstances

GET

/api/watchlist-manager/trends/{id}

GET

/api/watchlist-manager/trends/stats

Show

Watchlist Member Management Deprecated

Endpoints

GET

/api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members

POST

/api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members

GET

/api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}

DELETE

/api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}

GET

/api/watchlist-manager/facewatchlists/{watchlistId}/watchlist-members/{watchlistMemberId}/image

Show

Watchlist Management Deprecated

Endpoints

GET

/api/watchlist-manager/facewatchlists

POST

/api/watchlist-manager/facewatchlists

GET

/api/watchlist-manager/facewatchlists/{watchlistId}

POST

/api/watchlist-manager/facewatchlists/{watchlistId}

DELETE

/api/watchlist-manager/facewatchlists/{watchlistId}

Show

Watchlist Entry V2

Endpoints

GET

/api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}

DELETE

/api/watchlist-manager/watchlists/{watchlistId}/entries/{entryId}

GET

/api/watchlist-manager/watchlists/{watchlistId}/entries

POST

/api/watchlist-manager/watchlists/{watchlistId}/entries

Show

Tenant Management

Endpoints

GET

/api/identity-store/events/queries/{executionId}/result

GET

/api/identity-store/events/queries/{executionId}/status

GET

/api/identity-store/stats

POST

/api/identity-store/events/queries/start

Show

User Biometric Management

Endpoints

GET

/api/identity-store/stores/{storeName}/users/{extUserId}/biometrics/types/{type}/subtypes/{subtype}/versions/ext

GET

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

GET

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/types/{type}/subtypes/{subtype}/versions

DELETE

/api/identity-store/stores/{storeName}/users/{extId}/biometrics/{id}/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/biometrics

POST

/api/identity-store/stores/{storeName}/users/{userId}/biometrics

POST

/api/identity-store/stores/{storeName}/users/{extId}/biometrics/{type}/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/types/{type}/subtypes/{subtype}/versions/{versionId}/references

GET

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

DELETE

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

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/biometrics/ext

GET

/api/identity-store/stores/{storeName}/users/{extUserId}/biometrics/types/{type}/subtypes/{subtype}/versions/{versionId}/ext

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/biometrics/authentications/failure/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/types/{type}/subtypes/{subtype}

DELETE

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/types/{type}/subtypes/{subtype}

GET

/api/identity-store/stores/{storeName}/users/{extUserId}/biometrics/types/{type}/subtypes/{subtype}/versions/{versionId}/references/ext

POST

/api/identity-store/stores/{storeName}/users/{extId}/biometrics/authentications/face/ext

POST

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/authentications/failure

GET

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/types/{type}/subtypes/{subtype}/versions/{versionId}/data

POST

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/authentications/face

GET

/api/identity-store/stores/{storeName}/users/{extUserId}/biometrics/types/{type}/subtypes/{subtype}/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/types/{type}/subtypes/{subtype}/versions/{versionId}

GET

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

POST

/api/identity-store/stores/{storeName}/users/{userId}/biometrics/{type}

DELETE

/api/identity-store/stores/{storeName}/users/{extId}/biometrics/types/{type}/subtypes/{subtype}/ext

Show

User Appkey Management

Endpoints

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

POST

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

POST

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

GET

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

POST

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

DELETE

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

POST

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

DELETE

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

POST

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

POST

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

POST

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

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

DELETE

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

DELETE

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

GET

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

DELETE

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

DELETE

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

GET

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

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}/users/{userExtId}/appkeys/relyingParties/{rpId}/registrations/{regPolicyName}/ext

DELETE

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

DELETE

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

POST

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

POST

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

Show

User Passkey Management

Endpoints

POST

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

POST

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

GET

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

DELETE

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

GET

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

GET

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

POST

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

DELETE

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

GET

/api/identity-store/stores/{storeName}/users/{userId}/passkeys

GET

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

POST

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

POST

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

POST

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

POST

/api/identity-store/stores/{storeName}/passkeys/authentications

POST

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

GET

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

POST

/api/identity-store/stores/{storeName}/passkeys/registrations

POST

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

POST

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

POST

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

Show

Tenant Key Management

Endpoints

POST

/api/identity-store/keys/rotate

GET

/api/identity-store/keys

Show

User Passcode Management

Endpoints

POST

/api/identity-store/stores/{storeName}/passcodes/renewals/sessions/{sessionId}

POST

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

POST

/api/identity-store/stores/{storeName}/users/{extUserId}/passcodes/registrations/{policyName}/ext

GET

/api/identity-store/stores/{storeName}/users/{userExtId}/passcodes/ext

POST

/api/identity-store/stores/{storeName}/users/{extUserId}/passcodes/authentications/{policyName}/ext

POST

/api/identity-store/stores/{storeName}/users/{userId}/passcodes/authentications/{policyName}

GET

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

POST

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

DELETE

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

GET

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

POST

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

DELETE

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

GET

/api/identity-store/stores/{storeName}/users/{userId}/passcodes

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/passcodes/deregistrations/{policyName}/ext

POST

/api/identity-store/stores/{storeName}/users/{userId}/passcodes/renewals/{policyName}

GET

/api/identity-store/stores/{storeName}/users/{userExtId}/passcodes/registrations/{policyName}/ext

POST

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

POST

/api/identity-store/stores/{storeName}/users/{extUserId}/passcodes/renewals/{policyName}/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/passcodes/registrations/{policyName}

POST

/api/identity-store/stores/{storeName}/users/{userId}/passcodes/registrations/{policyName}

POST

/api/identity-store/stores/{storeName}/users/{userId}/passcodes/deregistrations/{policyName}

Show

User Push Notification Management

Endpoints

POST

/api/identity-store/stores/{storeName}/users/{userId}/pushNotifications/relyingParties/{rpId}

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/pushNotifications/relyingParties/{rpId}/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/pushNotifications

GET

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

GET

/api/identity-store/stores/{storeName}/users/{userExtId}/pushNotifications/ext

GET

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

Show

User Management

Endpoints

GET

/api/identity-store/stores/{storeName}/users/{extId}/authentications/ext

GET

/api/identity-store/stores/{storeName}/users

POST

/api/identity-store/stores/{storeName}/users

GET

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

POST

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

DELETE

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

GET

/api/identity-store/stores/{storeName}/users/{userId}/authentications

GET

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

GET

/api/identity-store/stores/{storeName}/users/{extId}/sessions/ext

GET

/api/identity-store/stores/{storeName}/users/{extId}/ext

POST

/api/identity-store/stores/{storeName}/users/{extId}/ext

DELETE

/api/identity-store/stores/{storeName}/users/{extId}/ext

GET

/api/identity-store/stores/{storeName}/users/{extId}/authentications/{id}/ext

GET

/api/identity-store/stores/{storeName}/users/{userId}/sessions

Show

User Totp Management

Endpoints

GET

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

POST

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

DELETE

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

GET

/api/identity-store/stores/{storeName}/users/{userId}/totps/registrations/{policyName}

POST

/api/identity-store/stores/{storeName}/users/{userId}/totps/registrations/{policyName}

POST

/api/identity-store/stores/{storeName}/users/{userId}/totps/authentications/{policyName}

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/totps/authentications/{policyName}/ext

POST

/api/identity-store/stores/{storeName}/users/{userId}/totps/deregistrations/{policyName}

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/totps/registrations/{policyName}/complete/ext

GET

/api/identity-store/stores/{storeName}/users/{userExtId}/totps/ext

POST

/api/identity-store/stores/{storeName}/users/{userId}/totps/registrations/{policyName}/complete

GET

/api/identity-store/stores/{storeName}/users/{userId}/totps

GET

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

POST

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

DELETE

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

GET

/api/identity-store/stores/{storeName}/users/{userExtId}/totps/registrations/{policyName}/ext

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/totps/registrations/{policyName}/ext

POST

/api/identity-store/stores/{storeName}/users/{userExtId}/totps/deregistrations/{policyName}/ext

Show

Store Appkey Configuration Management

Endpoints

GET

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

POST

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

DELETE

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

POST

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

Show

Store Passcode Policy Management

Endpoints

GET

/api/identity-store/stores/{storeName}/passcodePolicy/{policyName}

POST

/api/identity-store/stores/{storeName}/passcodePolicy/{policyName}

DELETE

/api/identity-store/stores/{storeName}/passcodePolicy/{policyName}

POST

/api/identity-store/stores/{storeName}/passcodePolicy

Show

Store Totp Policy Management

Endpoints

GET

/api/identity-store/stores/{storeName}/totpPolicy/{policyName}

POST

/api/identity-store/stores/{storeName}/totpPolicy/{policyName}

DELETE

/api/identity-store/stores/{storeName}/totpPolicy/{policyName}

POST

/api/identity-store/stores/{storeName}/totpPolicy

Show

Store Push Notification Policy Management

Endpoints

GET

/api/identity-store/stores/{storeName}/pushNotificationPolicy/{rpId}

POST

/api/identity-store/stores/{storeName}/pushNotificationPolicy/{rpId}

DELETE

/api/identity-store/stores/{storeName}/pushNotificationPolicy/{rpId}

GET

/api/identity-store/stores/{storeName}/pushNotifications/relyingParties

POST

/api/identity-store/stores/{storeName}/pushNotificationPolicy

Show

Store Management

Endpoints

GET

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

POST

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

DELETE

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

GET

/api/identity-store/stores

POST

/api/identity-store/stores

GET

/api/identity-store/stores/{storeName}/stats

Show

Store Passkey Configuration Management

Endpoints

POST

/api/identity-store/stores/{storeName}/passkeyConfig

GET

/api/identity-store/stores/{storeName}/passkeyConfig/{rpId}

POST

/api/identity-store/stores/{storeName}/passkeyConfig/{rpId}

DELETE

/api/identity-store/stores/{storeName}/passkeyConfig/{rpId}

Show

TrustX API Reference 1.0Terms of Service

Authentication

Api Keys

Obtain a bearer token by API Key for the tenant

List API Keys for the tenant

Create an API Key for a tenant

Get an API Key for a tenant

Update an API Key for a tenant

Delete an API Key.

Admin Sessions

Process Instance

Process Tokens

Process Definition Tags

Process Instances

Cloud Secrets

Audits

Userdata-controller

Custom Pages

Watchlist V2

Trends

Watchlist Member Management Deprecated

Watchlist Management Deprecated

Watchlist Entry V2

Tenant Management

User Biometric Management

User Appkey Management

User Passkey Management

Tenant Key Management

User Passcode Management

User Push Notification Management

User Management

User Totp Management

Store Appkey Configuration Management

Store Passcode Policy Management

Store Totp Policy Management

Store Push Notification Policy Management

Store Management

Store Passkey Configuration Management

TrustX API Reference 1.0 Terms of Service