Skip to main content

UserChallengeParameters

Request parameters for obtaining a challenge.

Properties

NameTypeDescriptionNotes
ApplicationIdstringUnique identifier of the Identity as a Service Authentication API application
AuthRequestKeystringUnique identifier of the client authentication request in the OIDC application's JWT IDaaS grant type use case.[optional]
AuthTokenstringAuthentication token (Required if the call to userQuery returned an authenticated token).[optional]
ClientIpstringProvided client IP address.[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]
LocalestringThe locale of this user. If not set, the default account locale will be used.[optional]
MachineAuthenticatorMachineAuthenticator[optional]
OfflineTVSbool?A flag indicating if the offline QR code token verification is used[optional]
OriginstringThe origin of the client. This field is deprecated, use rpId instead.[optional]
OtpDeliveryAttributestringOTP delivery attribute name.[optional]
OtpDeliveryTypestringDefines how a user receives their one-time passcode (Email, Text message (SMS), or Voice message (VOICE))[optional]
PassthroughAuthenticatorParmsPassthroughAuthenticatorParms[optional]
Priorityint?The 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]
PushMutualChallengeEnabledbool?A flag indicating if push mutual authentication is supported for tokens or Face Biometric[optional]
RequestAcrsstringThe request acrs.[optional]
RequestDetailRequestDetail[optional]
RpIdstringThe Relying Party ID associated with the passkey. This identifies the domain or origin for which the passkey is registered. This field is mandatory if domain is outside of the IDaaS hostname.[optional]
SecondFactorAuthenticatorstringAuthenticator type selected for second factor (if enabled).[optional]
SummarystringThe push authentication challenge that appears in the user's mobile application.[optional]
TokenPushMutualChallengeEnabledbool?A 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]