UserAuthenticateQueryParameters
Request parameters for starting user authentication process.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| applicationId | String | Unique identifier of the Identity as a Service Authentication API application | |
| authRequestKey | String | Unique identifier of the client authentication request in the OIDC application's JWT IDaaS grant type use case. | [optional] |
| authToken | String | Authentication token. | [optional] |
| clientIp | String | Provided client IP address. | [optional] |
| ignoreIPAddressForRBA | Boolean | Setting defines if IP Address is ignored for RBA or not. Default value is false and will not ignore IP Address for RBA. | [optional] |
| machineAuthenticator | MachineAuthenticator | [optional] | |
| maxAge | Integer | Maximum Authentication Age. If an authentication token is supplied, the maximum authentication age used to determine whether authentication is required or not is based on the current system time or a supplied request time. | [optional] |
| offlineTVS | Boolean | A flag indicating if the offline QR code token verification is used. Used only if a challenge is required for authentication when returnDefaultChallenge is true. | [optional] |
| origin | String | Provided client origin. | [optional] |
| priority | Integer | The priority for push transactions where queuing is enabled. Default is 0 and allowed values are 0-9. Used only if a challenge is required for authentication when returnDefaultChallenge is true. | [optional] |
| pushMessageIdentifier | String | Defines an identifier to retrieve customized SDK push message configuration. Used only if a challenge is required for authentication when returnDefaultChallenge is true. | [optional] |
| pushMutualChallengeEnabled | Boolean | A flag indicating if push mutual authentication is supported for tokens or Face Biometric. Used only if a challenge is required for authentication when returnDefaultChallenge is true. | [optional] |
| requestDetail | RequestDetail | [optional] | |
| requestTime | Long | The request start time in milliseconds. If an authentication token and a maximum authentication age are supplied, determining whether authentication is required or not is based on the current system time if this value is not provided. | [optional] |
| returnDefaultChallenge | Boolean | Flag indicating whether the service should include in the response the default challenge. | [optional] |
| summary | String | The push authentication challenge that appears in the user's mobile application. Used only if a challenge is required for authentication when returnDefaultChallenge is true. | [optional] |
| supportChoosingOtpDelivery | Boolean | Deprecated : Clients who support choosing OTP delivery can still work without having to supply this flag.Flag indicating whether client supports choosing OTP delivery contact attribute.If the client doesn't support it and default OTP delivery is set to NONE, OTP won't be available as an authenticator. | [optional] |
| tokenPushMutualChallengeEnabled | Boolean | A flag indicating if the token push mutual authentication is supported. Used only if a challenge is required for authentication when returnDefaultChallenge is true. | [optional] |
| transactionDetails | List<TransactionDetail> | Transaction Details. | [optional] |
| userId | String | User ID (containing the user ID or a user alias) of the Identity as a Service user completing the authentication challenge. |