Skip to main content

AuthenticatedResponse

Response associated with an authentication request.

Properties

NameTypeDescriptionNotes
authenticationCompletedBooleanFlag to indicate if authentication has successfully completed.[optional]
authenticatorResponsebyte[][optional]
deviceCertAuthDesiredBooleanFlag to indicate if the user has to attempt device certificate authentication.[optional]
expiresLongExpiry time of token.[optional]
faceChallengeFaceChallenge[optional]
fidoChallengeFIDOChallenge[optional]
firstNameStringFirst Name.[optional]
gridChallengeGridChallenge[optional]
kbaChallengeKbaChallenge[optional]
lastNameStringLast Name.[optional]
machineAuthenticatorMachineAuthenticator[optional]
offlineTokenResponsesOfflineTokenAuthenticateResponse[optional]
organizationsList<Organization>A list of the user organizations.[optional]
otpdeliveryTypeOtpdeliveryTypeEnumThe OTP delivery type used.[optional]
redirectUrlStringThe redirect URL when using a Magic Link.[optional]
smartLoginChallengeStringFor a SMART_LOGIN authenticator challenge, provides the challenge.[optional]
statusStatusEnumStatus of authenticator. This is not a required API field if Mobile Smart Credential or Token Push authentication is being used.[optional]
stepUpAuthExpiryLongThe timeout for step-up authentication[optional]
tempAccessCodeChallengeTempAccessCodeChallenge[optional]
timeLong[optional]
tokenStringAuthenticated/unauthenticated authorization token.[optional]
tokenChallengeTokenChallenge[optional]
tokenDetailsList<String>For a token or token push authenticator challenge, provides a list of serial numbers of the tokens that can be used to authenticate.[optional]
tokenPushMutualChallengeStringThe token push authentication mutual challenge.[optional]
transactionReceiptTransactionReceipt[optional]
userCertificateChallengeUserCertificateChallenge[optional]
userIdStringThe User ID of the Identity as a Service user that completed authentication.[optional]
userMachineSettingsUserMachineSettings[optional]
userRegistrationRequiredBooleanWhether the user still requires registration.[optional]
userVerificationRequiredBooleanWhether the user still requires verification.[optional]

OtpdeliveryTypeEnum

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

StatusEnum

NameValue
CONFIRM"CONFIRM"
CONCERN"CONCERN"
CANCEL"CANCEL"
NO_RESPONSE"NO_RESPONSE"