Skip to main content

UserChallengeParameters

Request parameters for obtaining a challenge.

Properties

NameTypeDescriptionNotes
applicationIdStringUnique identifier of the Identity as a Service Authentication API application
authTokenStringAuthentication token (Required if the call to userQuery returned an authenticated token).[optional]
clientIpStringProvided client IP address.[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]
localeStringThe locale of this user. If not set, the default account locale will be used.[optional]
machineAuthenticatorMachineAuthenticator[optional]
offlineTVSBooleanA flag indicating if the offline QR code token verification is used[optional]
originStringThe origin of the client[optional]
otpDeliveryAttributeStringOTP delivery attribute name.[optional]
otpDeliveryTypeOtpDeliveryTypeEnumDefines how a user receives their one-time passcode (Email, Text message (SMS), or Voice message (VOICE))[optional]
priorityIntegerThe priority for push transactions where queuing is enabled. Default is 0 and allowed values are 0-9[optional]
pushMessageIdentifierStringDefines an identifier to retrieve customized SDK push message configuration[optional]
requestDetailRequestDetail[optional]
secondFactorAuthenticatorSecondFactorAuthenticatorEnumAuthenticator type selected for second factor (if enabled).[optional]
summaryStringThe push authentication challenge that appears in the user's mobile application.[optional]
tokenPushMutualChallengeEnabledBooleanA flag indicating if the token push mutual authentication is supported[optional]
transactionDetailsList<TransactionDetail>Defines transaction details to be included in the challenge[optional]
userIdStringUser ID (containing the user ID or a user alias) of the Identity as a Service user completing the authentication challenge. The userid is required for non-passwordless authenticators.[optional]

OtpDeliveryTypeEnum

NameValue
EMAIL"EMAIL"
SMS"SMS"
VOICE"VOICE"

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"