Use the User Credentials service to create a user credential, and get the credential status. To issue the credential to the user, you’ll then use the Create a User Session request.

Alternatively, you can use the Credentials Issuance (Combined APIs) to both create the user credential, and issue the credential to the user. This reduces the requests to Create a User Credential, and Create a User Session to a single request.

User Credentials data model

Property Type Required? Mutable? Description
applicationInstanceId String Required Immutable The UUID for the application instance registered with the Id Routing service. This enables the client to send messages to the service.
credentialId String Required Immutable The UUID for the user credential.
credentialTypeId String Required Immutable The UUID of the credential type.
claimReference Object Required Immutable The serialized JSON object used to create the ClaimReference object returned. This is needed to revoke an issued credential.
environmentId String Required Immutable The UUID for the environment.
expiryDate Date Optional Mutable The date that the user credential expires. If this value is null, the credential never expires.
userId String Required Immutable The UUID of the user.
userMetadata String Required Immutable This is a JSON String containing a Map that lists the field values in the credential.

Response codes

Code Message
200 Successful operation.
400 The request could not be completed.
401 You do not have access to this resource.
403 You do not have permissions or are not licensed to make this request.
404 The requested resource was not found.
500 Unexpected server error.