authenticateUser response
The authenticateUser response returns the status of the request to authenticate a user.
authenticateUser
output fields lists details about the authenticateUser
output fields.Output Field | Required? | Type | Purpose |
|---|---|---|---|
requestId | Y | string | The requestId sent with the AuthenticateUserResponse request. |
status | Y | hex string | Unique status code. 0000=Success . Any other value is an error. |
statusMessage | Y | string | Message corresponding to the status of the request. If the status is not 0000 (success), this is an error message. |
Detail Code | N | hex string | Additional details about the authentication, if available. This element is not returned if there are no additional details. See Detail codes. |
Detail Message | N | string | Message providing additional details about the authentication, if available. This element is not returned if there are no additional details. |
credentialId | Y | string | Unique identifier of the credential. |
credentialType | Y | string | Identifies the credential type:
|
lastAuthnId | N | string | A unique identifier for this authentication sign-in event, if the authentication request was successful. |
isPinExpired | N | boolean | If a PIN is set for this user, identifies if the PIN has expired.
|
pinExpirationTime | N | dateTime | If a user PIN is set, identifies the date and time (in GMT format) that the PIN expires. |
authContext | N | string | The authentication level used when authenticating the user, if an authentication level was sent in the request. |