Profile Validation API guide

user_id

{
    "user_id": "<USERNAME>",
    "type": "user_id"
}

Example:

{
    "user_id": "jsmith",
    "type": "user_id"
}

{
   "status": "found",
   "message": "User Id found",
}

{
  "status": "not_found",
  "message": "User Id was not found."
}
HTTP Status 404

password

{
    "user_id": "<USERNAME>",
    "type": "password",
    "token": "<PASSWORD>"
}

Example:

{
    "user_id": "jsmith",
    "type": "password",
    "token": "P@$SW0RD"
}

Employ SecureAuth's Password Throttling functionality at this endpoint when validating passwords.

This requires configuration in the realm; refer to Password Throttling Configuration Guide for more information.

{
    "status": "valid",
    "message": ""
}

{
  "status": "invalid",
  "message": "User Id or password is invalid."
}

{
  "status": "invalid",
  "message": "A <X> value is required for this type."
}

{
  "status": "invalid",
  "message": "Unknown value. Supported values are: <X>."
}

kba

{
    "user_id": "<USERNAME>",
    "type": "kba",
    "token": "<ANSWER>",
    "factor_id": "<KBQ PROPERTY>"
}

Example:

{
    "user_id": "jsmith",
    "type": "kba",
    "token": "biking",
    "factor_id": "KBQ2"
}

{
    "status": "valid",
    "message": ""
}

{
  "status": "invalid",
  "message": "Knowledge base answer is incorrect."
}

{
  "status": "invalid",
  "message": "KBQ Id is out of range."
}

{
  "status": "invalid",
  "message": "A <X> value is required for this type."
}

{
  "status": "invalid",
  "message": "Unknown value. Supported values are: <X>."
}

oath

{
    "user_id": "<USERNAME>",
    "type": "oath",
    "token": "<OTP>",
    "factor_id": "<DEVICE IDENTIFIER>"
}

Example:

{
    "user_id": "jsmith",
    "type": "oath",
    "token": "123456",
    "factor_id": "a0b1cd23e4f5g67h8ij90k"
}

{
    "status": "valid",
    "message": ""
}

{
  "status": "invalid",
  "message": "OTP is invalid."
}

{
  "status": "invalid",
  "message": "A <X> value is required for this type."
}

{
  "status": "invalid",
  "message": "Unknown value. Supported values are: <X>."
}

pin

{
    "user_id": "<USERNAME>", 
    "type" : "pin", 
    "token": "<PIN NUMBER>"
}

Example:

{
    "user_id": "jsmith", 
    "type": "pin", 
    "token": "1234"
}

{
  "status": "valid",
  "message": ""
}

{
  "status": "invalid",
  "message": "PIN is invalid."
}

{
  "status": "invalid",
  "message": "Request validation failed with: <X> was not present."
}

call

{
    "user_id": "<USERNAME>",
    "type": "call",
    "factor_id": "<PHONE PROPERTY>",
    "evaluate_number": "true"
}

Example:

{
    "user_id": "jsmith",
    "type": "call",
    "factor_id": "Phone1"
    "evaluate_number": "true"
}

{
    "status": "valid",
    "message": "",
    "user_id": "jsmith",
    "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

sms

{
    "user_id": "<USERNAME>",
    "type": "sms",
    "factor_id": "<PHONE PROPERTY>"
    "evaluate_number": "true"
}

Example:

{
    "user_id": "jsmith",
    "type": "sms",
    "factor_id": "Phone1"
    "evaluate_number": "true"
}

{
    "status": "valid",
    "message": "",
    "user_id": "jsmith",
    "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

sms_link

{
    "user_id": "<USERNAME>",
    "type": "sms_link",
    "factor_id": "<PHONE PROPERTY>"
    "evaluate_number": "true"
}

Example:

{
    "user_id": "jsmith",
    "type": "sms_link",
    "factor_id": "Phone1"
    "evaluate_number": "true"
}

{
    "reference_id": "a7e855c1-45a3-XXXXXX",
    "status": "valid",
    "message": "",
    "user_id": "jsmith"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

email

{
    "user_id": "<USERNAME>",
    "type": "email",
    "factor_id": "<EMAIL PROPERTY>"
}

Example:

{
    "user_id": "jsmith",
    "type": "email",
    "factor_id": "Email1"
}

{
    "status": "valid",
    "message": "",
    "user_id": "jsmith",
    "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

email_link

{
    "user_id": "<USERNAME>",
    "type": "email_link",
    "factor_id": "<EMAIL PROPERTY>"
}

Example:

{
    "user_id": "jsmith",
    "type": "email_link",
    "factor_id": "Email1"
}

{
    "reference_id": "a7e855c1-45a3-XXXXXX",
    "status": "valid",
    "message": "",
    "user_id": "jsmith"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

push

{
    "user_id": "<USERNAME>",
    "type": "push",
    "factor_id": "<DEVICE IDENTIFIER>"
}

Example:

{
    "user_id": "jsmith",
    "type": "push",
    "factor_id": "z0y9x87wv6u5t43srq2p1on"
}

{
    "status": "valid",
    "message": "",
    "user_id": "jsmith",
    "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

push_accept

{
    "user_id": "<USERNAME>",
    "factor_id": "<DEVICE IDENTIFIER>",
    "type": "<PUSH-TO-ACCEPT TYPE>",
    "biometricType":"<BIOMETRIC TYPE>",
    "push_accept_details": {
        "company_name": "<COMPANY>",
        "application_description": "<APP>",
        "enduser_ip": "<IP ADDRESS>"
    }
}

Example:

{
    "user_id": "jsmith",
    "factor_id": "8117b62897734d71b4XXXXX",
    "type": "push_accept",
    "biometricType":"fingerprint",
    "push_accept_details": {
        "company_name": "ACME Corp",
        "application_description": "Salesforce",
        "enduser_ip": "111.222.33.44"
    }
}

{
  "reference_id": "a7e855c1-45a3-XXXXXX",
  "status": "valid",
  "message": "",
  "user_id": "jsmith"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

help_desk

{
    "user_id": "<USERNAME>",
    "type": "help_desk",
    "factor_id": "<HELPDESK PROPERTY>"
}

Example:

{
    "user_id": "jsmith",
    "type": "help_desk",
    "factor_id": "HelpDesk1"
}

{
    "status": "valid",
    "message": "",
    "user_id": "jsmith",
    "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown factor id '<X>'"
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

ad hoc call

Deliver OTP via phone call to a phone number not stored in the directory

{
  "user_id": "<USERNAME>",
  "type": "call",
  "token": "<UNREGISTERED PHONE>",
  "evaluate_number": "true"
}

Example:

{
  "user_id": "jsmith",
  "type": "call",
  "token": "443965551234"
  "evaluate_number": "true"
}

{
 "status": "valid",
  "message": "",
  "user_id": "jsmith",
  "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: User Id was not present."
}

{
  "status": "not_found",
  "message": "User Id was not found.",
  "user_id": "jsmith"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown value. Supported values are: 
   password, user_id, sms, call, email, kba, help_desk, push, push_accept, oath, pin."
}

{
  "status": "server_error",
  "message": "Error parsing phone field."
}

{
  "status": "server_error",
  "message": "The specified string is not in the form required for an e-mail address."
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

ad hoc sms

Deliver OTP via text message to a phone number not stored in the directory

{
  "user_id": "<USERNAME>",
  "type": "sms",
  "token": "<UNREGISTERED PHONE>"
  "evaluate_number": "true"
}

Example:

{
  "user_id": "jsmith",
  "type": "sms",
  "token": "443965551234"
  "evaluate_number": "true"
}

{
  "status": "valid",
  "message": "",
  "user_id": "jsmith",
  "otp": "8430"
}

{
  "status": "invalid",
  "message": "Request validation failed with: User Id was not present."
}

{
  "status": "not_found",
  "message": "User Id was not found.",
  "user_id": "jsmith"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown value. Supported values are: 
   password, user_id, sms, call, email, kba, help_desk, push, push_accept, oath, pin."
}

{
  "status": "server_error",
  "message": "Error parsing phone field."
}

{
  "status": "server_error",
  "message": "The specified string is not in the form required for an e-mail address."
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

ad hoc email

Deliver OTP via email to an email address not stored in the directory

{
  "user_id": "<USERNAME>",
  "type": "email",
  "token": "<UNREGISTERED EMAIL>"
}

Example:

{
  "user_id": "jsmith",
  "type": "call",
  "token": "jsmith@company.com"
}

{
  "status": "valid",
  "message": "",
  "user_id": "jsmith",
  "otp": "8430"
} 

{
  "status": "invalid",
  "message": "Request validation failed with: User Id was not present."
}

{
  "status": "not_found",
  "message": "User Id was not found.",
  "user_id": "jsmith"
}

{
  "status": "invalid",
  "message": "Request validation failed with: Unknown value. Supported values are: 
   password, user_id, sms, call, email, kba, help_desk, push, push_accept, oath, pin."
}

{
  "status": "server_error",
  "message": "Error parsing phone field."
}

{
  "status": "server_error",
  "message": "The specified string is not in the form required for an e-mail address."
}

In case of a server error, it returns the following response:

{
  "status": "server_error",
  "message": "<Exception message describing the issue.>",
}
HTTP Status 500

{
  "status": "found",
  "message": "ACCEPTED"
}

{
  "status": "found",
  "message": "DENIED"
}

{
  "status": "found",
  "message": "FAILED"
}

{
  "status": "found",
  "message": "EXPIRED"
}

{
  "status": "found",
  "message": "PENDING"
}

{
  "status": "not_found",
  "message": "NOTFOUND"
}

{
  "status": "invalid",
  "message": "Invalid reference ID."
}

{
  "status": "found",
  "message": "ACCEPTED"
}

{
  "status": "found",
  "message": "DENIED"
}

{
  "status": "found",
  "message": "FAILED"
}

{
  "status": "found",
  "message": "EXPIRED"
}

{
  "status": "found",
  "message": "PENDING"
}

{
  "status": "not_found",
  "message": "NOTFOUND"
}

{
  "status": "invalid",
  "message": "Invalid reference ID."
}