Skip to main content

UserAuthenticateParameters

Request parameters for completing authentication process.

Properties

NameTypeDescriptionNotes
application_idstrUnique identifier of Identity as a Service Authentication API application.[optional]
application_infostrClient provided information about the application that will be included in the authentication audits if provided.[optional]
cancelboolCancel Identity as a Service authentication to the application[optional]
certificatestrThe certificate with public key to verify signature.[optional]
chap_responseobject[optional]
client_ipstrProvided client IP address.[optional]
enable_web_sessionboolIf 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]
face_responsestrFor Face Biometric authentication, the workflow run id to check.[optional]
fido_responseFIDOResponse[optional]
ignore_ip_address_for_rbaboolSetting defines if IP Address is ignored for RBA or not. Default value is false and will not ignore IP Address for RBA.[optional]
kba_challengeKbaChallenge[optional]
localestrThe locale of this user. If not set, the default account locale will be used.[optional]
machine_authenticatorMachineAuthenticator[optional]
machine_authenticator_registrationMachineAuthenticatorRegistration[optional]
mschap_v1_responseMSCHAPv1Response[optional]
mschap_v2_responseMSCHAPv2Response[optional]
new_passwordstrNew password if change requested.[optional]
offline_tvsboolA flag indicating if the offline QR code token verification is used[optional]
responsestrAPI 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]
second_factor_authenticatorstrAuthenticator type selected for second factor (if enabled).[optional]
token_protected_offline_parmsTokenProtectedOfflineParms[optional]
transaction_detailsList[TransactionDetail]Transaction Details.[optional]
user_certificate_responseUserCertificateResponse[optional]
user_idstrUser ID (containing the user ID or a user alias) of the Identity as a Service user completing the authentication challenge.[optional]

Example