Skip to main content

UserAuthenticateParameters

Request parameters for completing authentication process.

Properties

NameTypeDescriptionNotes
ApplicationIdstringUnique identifier of Identity as a Service Authentication API application.[optional]
ApplicationInfostringClient provided information about the application that will be included in the authentication audits if provided.[optional]
Cancelbool?Cancel Identity as a Service authentication to the application[optional]
CertificatestringThe certificate with public key to verify signature.[optional]
ChapResponseObject[optional]
ClientIpstringProvided client IP address.[optional]
EnableWebSessionbool?If set to true, enhanced session protection is enabled for the auth token. An HTTP cookie named INTELLITRUST_SESSION_ID is returned with the response and must be returned in all subsequent requests using the auth token.[optional]
FaceResponsestringFor Face Biometric authentication, the workflow run id to check.[optional]
FidoResponseFIDOResponse[optional]
IgnoreIPAddressForRBAbool?Setting defines if IP Address is ignored for RBA or not. Default value is false and will not ignore IP Address for RBA.[optional]
KbaChallengeKbaChallenge[optional]
LocalestringThe locale of this user. If not set, the default account locale will be used.[optional]
MachineAuthenticatorMachineAuthenticator[optional]
MachineAuthenticatorRegistrationMachineAuthenticatorRegistration[optional]
MschapV1ResponseMSCHAPv1Response[optional]
MschapV2ResponseMSCHAPv2Response[optional]
NewPasswordstringNew password if change requested.[optional]
OfflineTVSbool?A flag indicating if the offline QR code token verification is used[optional]
ResponsestringAPI response based on Authenticator type. This is not a required field if Mobile Smart Credential, KBA, Token Push, or Smart Login authentication is being used.[optional]
SecondFactorAuthenticatorstringAuthenticator type selected for second factor (if enabled).[optional]
TokenProtectedOfflineParmsTokenProtectedOfflineParms[optional]
TransactionDetailsList<TransactionDetail>Transaction Details.[optional]
UserCertificateResponseUserCertificateResponse[optional]
UserIdstringUser ID (containing the user ID or a user alias) of the Identity as a Service user completing the authentication challenge.[optional]