Identity Store Activities
Passkey Activities
Start Passkey Registration
Begins the passkey registration process.
| Parameter | Description | Type | Default |
|---|---|---|---|
| challenge | The signed challenge is represented by a public key registered to the User. This value is auto-generated. | String | |
| Create User | If enabled, a new User will be created as part of the passkey registration. Default behavior is disabled. | Boolean | ${false} |
| Passkey Registration Key | Required - The unique ID associated with the passkey registration activity. | String | passkeyReg1 |
| Passkey User Display Name | Required - An informal display name associated with the User. | String | |
| Passkey User Handle | A unique identifier that is used to identify the credentials of the User per relying party. This value is a base-64 encoded string of bytes with a maximum length of 64 bytes. | Base-64 URL Encoded String of Bytes | |
| Passkey User Name | Required - A unique Username to identify the User. | String | |
| Registration Policy | Required - The name of the registration policy. | String | |
| Relying Party ID | Required - The ID of the relying party whose passkey registration configuration will be used. | String | |
| Store Name | Required - The name of the Identity Store. | String | |
| User External Id | Required - If the 'Create User' property is enabled, this property must be configured as a unique ID for the newly created User. Optional - If the 'Create User' property is disabled, this property can be used to identify the User that the passkey registration applies to. |
String | |
| User ID | The unique ID automatically generated when the User is created. In the context of the 'Start Passkey Registration' activity, this ID can be used to identify the User that the passkey registration applies to. | String | |
| User Key | The User Key that can be used to identify the User that the passkey registration applies to. | String | user1 |
Complete Passkey Registration
Finalizes the passkey registration process.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Fail Check on Cancel | If enabled, checks will fail if the end-user cancels out of the process. Default behavior is disabled. | Boolean | ${false} |
| Passkey Registration Browser Response | This input parameter must be set when the passkey registration flow uses a Custom Page to collect data instead of a form. In order to complete the passkey registration, a response from the browser must be provided. This response is returned from the Custom Page and can be entered into the 'Passkey Registration Browser Response' using variable substitution. ${_customUis.{{customPageKey}}_.currentCapture.customPageParameters.passkeyRegClientResponse.value} |
String | |
| Passkey Registration Key | The unique ID associated with the passkey registration attempt. | String | passkeyReg1 |
Start Passkey Authentication
Begins the passkey authentication process.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Authentication Policy | The authentication policy to use for the authentication process. | String | |
| Challenge | The signed challenge is represented by a public key registered to the User. This value is auto-generated. | String | |
| Passkey Authentication Key | Required - The unique ID associated with the passkey authentication activity. | String | passkeyAuth1 |
| Relying Party ID | Required - The ID of the relying party whose passkey registration configuration will be used. | String | |
| Store Name | Required - The name of the Identity Store. | String | |
| User External ID | This property can be used to identify the User that the passkey registration applies to. | String | |
| User ID | The unique ID automatically generated when the User is created. In the context of the 'Start Passkey Registration' activity, this ID can be used to identify the User that the passkey registration applies to. | String | |
| User Key | The User Key that can be used to identify the User that the passkey authentication applies to. | String | user1 |
Complete Passkey Authentication
Finalizes the passkey authentication process.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Fail Check on Cancel | If enabled, checks will fail if the end-user cancels out of the process. Default behavior is disabled. | Boolean | ${false} |
| Passkey Authentication Browser Response | This input parameter must be set when the passkey registration flow uses a Custom Page to collect data instead of a form. In order to complete the passkey authentication, a response from the browser must be provided. This response is returned from the Custom Page and can be entered into the 'Passkey Authentication Browser Response' using variable substitution. ${_customUis.{{customPageKey}}.currentCapture.customPageParameters.passkeyAuthClientResponse.value} |
STRING | |
| Passkey Authentication Key | The unique ID associated with the passkey authentication attempt. | STRING | passkeyAuth1 |
User Activities
Add User
This activity can be used to add a User to a specified Identity Store. The 'User External ID' is used to identify the newly added User. If no External ID is supplied, an ID will be generated automatically. An additional 'User ID' is also generated automatically by TrustX upon the creation of a new User and can be used for identifying a User.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store that the User will be added to. | String | |
| User Attributes | <String,String>< | A key-value pair of additional optional attributes used to describe the User. | |
| User Date of Birth | The User's date of birth in the format: "yyyy-mm-dd" | Date | |
| User Email | The User's email address in the format: "example@domain.com" | String | |
| User External ID | A unique User ID. If no ID is required, an external ID will be generated automatically by TrustX. | String | |
| User First Name | The first name of the User. | String | |
| User Key | Required - A key used to identify the User. | String | user1 |
| User Last Name | The last name of the User. | String | |
| User Locale - Country | The User country. | String | |
| User Locale - Language | An two-letter [ISO-639](https://www.iso.org/iso-639-language-code) formatted language tag. | String | |
| User Locale - Variant | A variant subtag of the User country. 5-8 letters or 4 characters starting with a digit, separated by hyphens. | String | |
| User Nationalities | The nationality of the User. | String | |
| User Status | The User status indicates whether the User is in a pending, active, locked or disabled state. | String | |
| User Timezone | The timezone of the User Country. This value must be in line with [TZDB](https://www.iana.org/time-zones) code format. Example: EST. |
String | |
| User Type | An optional parameter used for organizing Users into different types. A maximum of 64 characters is allowed. | String |
Get User
Returns information regarding the specified User.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store that the User belongs to. | String | |
| User External ID | The External ID of the User to be returned. | String | |
| User ID | The ID of the User to be returned. | String | |
| User Key | The User Key of the User to be returned. | String | user1 |
Update User
This activity can be used to update various attributes of a User.
It is not possible to update the locking status of a User when using this activity. For this functionality, use the Lock User and Unlock User activities.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store that the User will be added to. | String | |
| User Attributes | <String,String>< | A key-value pair of additional optional attributes used to describe the User. | |
| User Date of Birth | The User's date of birth in the format: "yyyy-mm-dd" | Date | |
| User Email | The User's email address in the format: "example@domain.com" | String | |
| User External ID | Can be used to update the External ID of the User. | String | |
| User First Name | The first name of the User. | String | |
| User Key | Required - A key used to identify the User. | String | user1 |
| User Last Name | The last name of the User. | String | |
| User Locale - Country | The User country. | String | |
| User Locale - Language | An [ISO-639](https://www.iso.org/iso-639-language-code) formatted language tag. | String | |
| User Locale - Variant | A variant subtag of the User country. 5-8 letters or 4 characters starting with a digit, separated by hyphens. | String | |
| User Nationalities | The nationality of the User. | String | |
| User Status | The User status indicates whether the User is in a pending, active, locked or disabled state. | String | |
| User Timezone | The timezone of the User Country. This value must be in line with [TZDB](https://www.iana.org/time-zones) code format. Example: EST. |
String | |
| User Type | An optional parameter used for organizing Users into different types. A maximum of 64 characters is allowed. | String |
Delete User
Deletes a User from an Identity Store. Requires one of the following identifiers to identify the User; User External ID, User ID, or User Key.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store that the User belongs to. | String | |
| User External ID | The External ID of the User to be deleted. | String | |
| User ID | The ID of the User to be deleted. | String | |
| User Key | The User Key of the User to be deleted. | String | user1 |
Lock User
This activity will place the specified User in a hard lock status. This will take precedence over any temporary lock placed on the User at the Identity Store level.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store of the User. | String | |
| User External ID | The External ID of the User to be locked. | String | |
| User ID | The ID of the User to be locked. | String | |
| User Key | The User Key of the User to be locked. | String | user1 |
Unlock User
This activity will unlock the specified User. All locks, including hard and temporary locks will be removed and the User will be returned to an active status.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Store Name | Required - Represents the Identity Store of the User. | String | |
| User External ID | The External ID of the User to be unlocked. | String | |
| User ID | The ID of the User to be unlocked. | String | |
| User Key | The User Key of the User to be unlocked. | String | user1 |
Add Face Image to User
Adds a face image to the specified User.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Face Key | Required - This represents the key of the face image to be added. | String | face1 |
| Store Name | Required - Represents the Identity Store of the User. | String | |
| User External ID | The External ID of the User. | String | |
| User ID | The ID of the User. | String | |
| User Key | The User Key of the User. | String | user1 |
Match Face Image to User
Performs a face match between a live image and the image associated with a User.
| Parameter | Description | Type | Default |
|---|---|---|---|
| Error navigation screen | The screen that is shown when an error occurs. | String | instructions |
| Exception On Max Attempts Exceeded | If enabled, an exception will be thrown when the alotted maximum match attempts is exceeded. | Boolean | ${true} |
| Face Key | Required - This represents the key of the face image that will be matched against the User face image. | String | face1 |
| Max Attempts | The maximum number of match attempts before an exception is thrown. | Integer | |
| Store Name | Required - Represents the Identity Store of the User. | String | |
| User External ID | The External ID of the User. | String | |
| User ID | The ID of the User. | String | |
| User Key | The User Key of the User. | String | user1 |