New User Authentication API

success

Boolean

Shows whether operation was successful or not.

response_code

String

Returns response code of success.

status

String

Shows status of MFA.

The possible values are: pending , expired, approved , rejected.

session_uid

String

A unique identifier for the session. This is the unique value that the relying party should generate for the lifetime of a session and should be unique across the relying party organization between different applications.

user_email

String

Email address of the user that is authenticating.

auth_options

Array

Allowed authentication methods for the MFA step.

The possible values are: push , sms , email , voice , totp.

expires_at

String

Shows expiry time of MFA in ISO 8601 format.

notification_type

String

The type of notification that has been sent to the user, if any.

response_code

String

Normalized response code describing the error type.

success

String

Generally false.

message

String

Informative message describing the error.

no_authenticator_found

String

No authenticator with the specified type found for the organization.

HTTP/1.1 422 Unprocessable Entity

{
  "content": {
    "response_code": "no_authenticator_found",
    "success": false,
    "message": "Something went wrong, Please contact support@secureauth.com for further assistance."
  }
}

generic_error

String

If anything else goes wrong, such as a missing parameter or invalid JWT, then a general error message is returned

HTTP/1.1 4XX OK

{
  "response_code": "generic_error",
  "success": false,
  "message": "error message"
}

response_code

String

Returns response code.

The possible values are: push_sent , sms_sent , email_sent , voice_sent.

success

Boolean

Shows whether operation was successful or not.

status

String

Shows status of MFA.

The possible values are: pending , expired, approved , rejected.

expires_at

String

Shows expiry time of MFA in ISO 8601 format.

notification_type

String

Notification type sent to user.

The possible values are: sms , email , call , push.

message

String

Message that can be shown to end-user.

response_code

String

Normalized response code describing the error type.

success

String

Generally false.

message

String

Informative message describing the error.

mfa_invalid_state

String

Authentication request is no longer valid, no OOB sent.

HTTP/1.1 200 OK

{
  "content": {
    "response_code": "mfa_invalid_state",
    "success": false,
    "message": "Your authentication request is no longer valid, please try to login again.",
    "expires_at": "2020-02-11T10:23:57-08:00",
    "notification_type": "sms/email/voice",
    "status": "expired/rejected/approved"
  }
}

not_allowed

String

Authentication method not allowed for this application and user.

HTTP/1.1 200 OK

{
  "content": {
    "response_code": "not_allowed",
    "success": false,
    "message": "Authentication method is not allowed for this application and user!",
    "expires_at": "2020-02-11T10:23:57-08:00",
    "notification_type": null,
    "status": "pending"
  }
}

wait_for_resend

String

Must wait to re-send OOB notification.

HTTP/1.1 200 OK

{
  "content": {
    "response_code": "wait_for_resend",
    "success": false,
    "message": "MFA request rate exceeded. Please wait 22 seconds before requesting a new sms.",
    "expires_at": "2020-02-11T10:23:57-08:00",
    "notification_type": "sms",
    "status": "pending"
  }
}

tfa_not_found

String

No TFA with the given channel found for this application.

HTTP/1.1 404 Not Found

{
  "content": {
    "response_code": "tfa_not_found",
    "success": false,
    "message": "No authentication request found for this user with the specified channel.",
  }
}

success

Boolean

Shows whether the API call was successful or not.

response_code

String

Returns response code of success.

status

String

Shows status of MFA.

The possible values are: pending , expired, approved , rejected.

message

String

Message that explains success.

retry_attempts_remaining

Integer

The number of attempts remaining to verify factor.

response_code

String

Normalized response code describing the error type.

success

String

Generally false.

message

String

Informative message describing the error.

mfa_invalid_state

String

Authentication request is no longer valid, or OTP not checked.

HTTP/1.1 200 OK

{
    "response_code": "mfa_invalid_state",
    "success": false,
    "message": "Your authentication request is no longer valid, please try to login again.",
    "status": "expired/rejected/approved"
}

invalid_otp

String

Invalid passcode specified.

HTTP/1.1 200 OK

{
    "response_code":"invalid_otp",
    "success": false,
    "message":"Invalid passcode was specified, please try again!",
    "status": "pending",
    "retry_attempts_remaining": 2
}

max_retry

String

OTP is invalid and the number of max attempts has been exceeded.

TFA is automatically rejected.

HTTP/1.1 200 OK

{
    "response_code": "max_retry",
    "success": false,
    "message":"Maximum PIN attempts exceeded. Authorization request denied.",
    "status": "rejected",
    "retry_attempts_remaining": 0
}

tfa_not_found

String

No TFA with the given channel found for this application.

HTTP/1.1 404 Not Found

{
    "response_code": "tfa_not_found",
    "success": false,
    "message": "No authentication request found for this user with the specified channel.",
}

success

Boolean

Whether the API call was successful or not.

response_code

String

Normalized response code describing the error type or "success".

status

String

Shows status of MFA, possible values pending/expired/approved/rejected.

channel

String

The channel uniquely identifying the TFA.

user_id

String

Internal user ID.

expires_at

String

The TFA expiry in ISO 8601 format.

session_uid

String

Unique user session identifier.

response_code

String

Normalized response code describing the error type.

success

String

Generally false.

message

String

Informative message describing the error.

tfa_not_found

String

No TFA with the given channel found for this application.

HTTP/1.1 404 Not Found

{
  "content": {
    "response_code": "tfa_not_found",
    "success": false,
    "message": "No authentication request found for this user with the specified channel.",
  }
}