Skip to main content

Request User Challenge

POST 
/api/web/v2/authentication/users/authenticate/:authenticator

Request User Challenge

Request​

Path Parameters

    authenticator stringrequired

    Possible values: [MACHINE, PASSWORD, EXTERNAL, KBA, TEMP_ACCESS_CODE, OTP, GRID, TOKEN, TOKENPUSH, FIDO, SMARTCREDENTIALPUSH, PASSWORD_AND_SECONDFACTOR, SMART_LOGIN, IDP, PASSKEY, IDP_AND_SECONDFACTOR, USER_CERTIFICATE, FACE]

Body

required

    applicationId stringrequired

    Unique identifier of the Identity as a Service Authentication API application

    authToken string

    Authentication token (Required if the call to userQuery returned an authenticated token).

    clientIp string

    Provided client IP address.

    ignoreIPAddressForRBA boolean

    Setting defines if IP Address is ignored for RBA or not. Default value is false and will not ignore IP Address for RBA.

    locale string

    The locale of this user. If not set, the default account locale will be used.

    machineAuthenticator

    object

    Machine authenticator required to complete authentication challenge

    fingerprint string

    The device fingerprint if it's required during Machine authentication. It will always be null when returned from IDaaS as part of the response body.

    machineNonce string

    machineNonce

    sequenceNonce string

    sequenceNonce

    offlineTVS boolean

    A flag indicating if the offline QR code token verification is used

    origin string

    The origin of the client

    otpDeliveryAttribute string

    OTP delivery attribute name.

    otpDeliveryType string

    Possible values: [EMAIL, SMS, VOICE]

    Defines how a user receives their one-time passcode (Email, Text message (SMS), or Voice message (VOICE))

    priority int32

    The priority for push transactions where queuing is enabled. Default is 0 and allowed values are 0-9

    pushMessageIdentifier string

    Defines an identifier to retrieve customized SDK push message configuration

    requestDetail

    object

    Request detail items.

    browser string

    The browser associated with the request.

    os string

    The OS associated with the request.

    secondFactorAuthenticator string

    Possible values: [MACHINE, PASSWORD, EXTERNAL, KBA, TEMP_ACCESS_CODE, OTP, GRID, TOKEN, TOKENPUSH, FIDO, SMARTCREDENTIALPUSH, PASSWORD_AND_SECONDFACTOR, SMART_LOGIN, IDP, PASSKEY, IDP_AND_SECONDFACTOR, USER_CERTIFICATE, FACE]

    Authenticator type selected for second factor (if enabled).

    summary string

    The push authentication challenge that appears in the user's mobile application.

    tokenPushMutualChallengeEnabled boolean

    A flag indicating if the token push mutual authentication is supported

    transactionDetails

    object[]

    Defines transaction details to be included in the challenge

  • Array [

    • detail string

    The transaction detail name.

    usage string[]

    Possible values: [RBA, TVS]

    value string

    The transaction detail value.

  • ]

    • userId string

    User 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.

Responses​

Authenticators retrieved successfully

Schema

    authenticationCompleted boolean

    Flag to indicate if authentication has successfully completed.

    authenticatorResponse byte
    deviceCertAuthDesired boolean

    Flag to indicate if the user has to attempt device certificate authentication.

    expires int64

    Expiry time of token.

    faceChallenge

    object

    Parameters returned to initialize a Face Biometric authenticator.

    applicantId string

    Applicant ID associated with the user.

    sdkToken string

    The SDK token generated for the user.

    workflowRunId string

    Workflow run ID to use for the user.

    fidoChallenge

    object

    If the authentication challenge is of type FIDO, the FIDOChallenge will contain the FIDO challenge parameters that must be passed to the FIDO token to complete authentication.

    allowCredentials string[]

    The list of IDs of the FIDO tokens registered for the user. Each value is base-64 encoded.

    challenge stringrequired

    A random challenge. It is a base-64 encoded value.

    timeout int32required

    The number of seconds that the client will wait for the FIDO token to respond.

    firstName string

    First Name.

    gridChallenge

    object

    If the authentication challenge is of type grid, the GridChallenge object will contain the grid challenge that the end user must answer.

    challenge

    object[]

    required

    The grid challenge specifies a list of grid cells that the user must answer in their challenge.

  • Array [

    • column int32required

    The column within the grid starting at 0.

    row int32required

    The row within the grid starting at 0.

  • ]

    • gridInfo

    object[]

    required

    The grid details.

  • Array [

    • expiryDate date-time

    The expiry date of the grid. Null value indicates the grid will never expire.

    serialNumber stringrequired

    The serial number of the grid that can be used to answer this challenge.

  • ]

    • numCharsPerCell int32required

    The numCharsPerCell value specifies the number of characters expected in the response for each cell as defined by current settings.

    serialNumbers string[]requireddeprecated

    The serial numbers of the grids that can be used to answer this challenge.

    kbaChallenge

    object

    Knowledge-based authenticator required for authentication to Identity as a Service

    id string

    userQuestions

    object[]

    required

  • Array [

    • answer string

    The question's answer.

    id string

    The UUID of the KBA question/answer.

    question string

    The question.

  • ]

    • lastName string

    Last Name.

    machineAuthenticator

    object

    Machine authenticator required to complete authentication challenge

    fingerprint string

    The device fingerprint if it's required during Machine authentication. It will always be null when returned from IDaaS as part of the response body.

    machineNonce string

    machineNonce

    sequenceNonce string

    sequenceNonce

    offlineTokenResponses

    object

    Used to return batches of protected OTPs for a given token

    firstMovingFactor int64

    This is the moving factor index for the first hashed OTP returned. In the case of time-based tokens, it represents time step, otherwise it represents the value of the counter.

    iterations int32

    The number of iterations of the hash function to be performed.

    maxSizeInUnits int32

    This is the policy-configured maximum number (hours or counters)

    maxTimeSteps int32

    This is the max number of time steps used to validate a token.

    minorSizeInUnits int32

    This is the policy-configured recommended number (hours or counters)

    otps string

    An array of all of the OTPs returned in the batch, each with its public component of the salt.

    privateSaltLength int32

    The number of digits in the private part of the salt that the client must guess.

    resultOptimized boolean

    Flag indicating if the set of OTP hashes returned was optimized so that OTPs which have already been downloaded in prior requests, but that have no yet expired, are not sent again.

    timeDrift int32

    This is the token time drift in seconds. This applies only to time-based tokens.

    timeInterval int32

    If this contains a positive value then this batch is for time-based tokens, otherwise it is for event based tokens.

    tokenSerialNumber string

    The serial number of the token for which offline tokens are generated.

    useSecret byte

    organizations

    object[]

    A list of the user organizations.

  • Array [

    • description string

    The description of the organization.

    displayName stringrequired

    The display name of the organization.

    id stringrequired

    The unique UUID assigned to the organization when it is created.

    logoUri string

    The URI of the logo to display when showing organizations.

    name stringrequired

    The name of the organization.

  • ]

    • otpdeliveryType string

    Possible values: [EMAIL, SMS, VOICE]

    The OTP delivery type used.

    redirectUrl string

    The redirect URL when using a Magic Link.

    smartLoginChallenge string

    For a SMART_LOGIN authenticator challenge, provides the challenge.

    status string

    Possible values: [CONFIRM, CONCERN, CANCEL, NO_RESPONSE]

    Status of authenticator. This is not a required API field if Mobile Smart Credential or Token Push authentication is being used.

    stepUpAuthExpiry int64

    The timeout for step-up authentication

    tempAccessCodeChallenge

    object

    Information about the temporary access code settings.

    adminContact string

    An optional admin contact value (like an admin email address or phone number) to be displayed in the admin contact message.

    enableAdminContact boolean

    Indicates if the admin contact message should be displayed for this challenge.

    time int64
    token string

    Authenticated/unauthenticated authorization token.

    tokenChallenge

    object

    If the authentication challenge is of offline token, the TokenChallenge object will contain the QR codes can be scanned by the mobile app.

    token

    object[]

    required

    The token challenge contains a list of TokenInfo objects for each of the token that can be used to authenticate. In the case of an offline QR code challenge, a TokenInfo object includes the QR code.

  • Array [

    • label string

    Optional label to identify an assigned token: a String up to 100 characters.

    qrCode string

    The base-64 encoded QR code. This QR code can be scanned by the Entrust Identity mobile application to perform activation in the case of an offline QR code challenge.

    qrCodeUrl string

    The URL based QR code string. In the case of an offline QR code challenge, this string can be used to generated the base-64 encoded QR code.

    serialNumber string

    The serial number of the token.

  • ]

    • tokenDetails string[]

    For a token or token push authenticator challenge, provides a list of serial numbers of the tokens that can be used to authenticate.

    tokenPushMutualChallenge string

    The token push authentication mutual challenge.

    transactionReceipt

    object

    Transaction Receipt item and its value used with push authenticators and with offline transaction verification.

    authenticationType string

    Possible values: [OTP, TOKEN]

    The transaction authentication type.

    date date-time

    The transaction date.

    details

    object[]

    The transaction details.

  • Array [

    • detail string

    The transaction detail name.

    usage string[]

    Possible values: [RBA, TVS]

    value string

    The transaction detail value.

  • ]

    • id string

    The transaction id.

    securityLevel string

    Possible values: [LOW, MEDIUM, HIGH]

    The transaction authentication security level.

    userid string

    The transaction user.

    userCertificateChallenge

    object

    For a user certificate authenticator challenge, provides the challenge.

    challenge stringrequired
    userId string

    The User ID of the Identity as a Service user that completed authentication.

    userMachineSettings

    object

    UserMachineSettings

    attributeExclusions string[]

    List of device fingerprinting attributes that should not be collected when a device fingerprint is captured.

    deviceFingerprintRequired boolean

    Indicates whether a device fingerprint should be captured during machine registration or authentication

    machineAuthenticatorEnabled boolean

    machineAuthenticatorEnabled

    userMachineAuthenticators

    object[]

    List of Machine Authenticators that the user currently has--used to prevent duplicated labels.

  • Array [

    • expiryTime date-time

    When this machine secret expires in UTC time

    id stringrequired

    Identifies the device/machine

    label stringrequired

    Identifies the device/machine from the end-user point of view

    lastUsedTime date-time

    When this machine secret was last used

    registrationTime date-timerequired

    When this machine secret was created in UTC time

  • ]

    • userRegistrationRequired boolean

    Whether the user still requires registration.

    userVerificationRequired boolean

    Whether the user still requires verification.

Loading...