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]
cancelBooleanCancel 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]
enableWebSessionBooleanIf 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]
ignoreIPAddressForRBABooleanSetting 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]
offlineTVSBooleanA 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]
secondFactorAuthenticatorSecondFactorAuthenticatorEnumAuthenticator 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]

SecondFactorAuthenticatorEnum

NameValue
MACHINE"MACHINE"
PASSWORD"PASSWORD"
EXTERNAL"EXTERNAL"
KBA"KBA"
TEMP_ACCESS_CODE"TEMP_ACCESS_CODE"
OTP"OTP"
GRID"GRID"
TOKEN"TOKEN"
TOKENPUSH"TOKENPUSH"
FIDO"FIDO"
SMARTCREDENTIALPUSH"SMARTCREDENTIALPUSH"
PASSWORD_AND_SECONDFACTOR"PASSWORD_AND_SECONDFACTOR"
SMART_LOGIN"SMART_LOGIN"
IDP"IDP"
PASSKEY"PASSKEY"
IDP_AND_SECONDFACTOR"IDP_AND_SECONDFACTOR"
USER_CERTIFICATE"USER_CERTIFICATE"
FACE"FACE"