Retrieve JWT token

Retrieves a JWT token using login credentials such as Email, Phone, Username, and Password.

Authorization

apikey<token>

Tenant API Key for authentication

In: query

Path Parameters

JwtAppName*string

JWT App Name

Query Parameters

Nonce?string

random nonce claim

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

email*string

password*string

GoogleRecaptchaResponse?|

The Google reCAPTCHA response which is sent to the server for verification.

QQCaptchaTicket?|

The QQ Captcha ticket which is sent to the server for verification.

QQCaptchaRandomString?|

The QQ Captcha random string which is sent to the server for verification.

HCaptchaResponse?|

The hCaptcha response which is sent to the server for verification.

phone*string

The Phone number of the User

password*string

The Password of the User

Formatpassword

securityAnswer?string

The security answer which is set for the User, this will be used when the User is blocked for the security question.

password*string

username*string

Response Body

`application/json`

curl -X POST "https://TenantName.hub.loginradius.com/api/jwt/example_jwt_app/login?Nonce=3f444945100b4730810bf4598841769d" \  -H "Content-Type: application/json" \  -d '{    "email": "user123@example.com",    "password": "Password123"  }'

{
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxMTI1NjNmNi0xNDgwLTQwYjgtOGUyOC1lMDcyY2EyMTJjODIiLCJlbWFpbCI6Im1heWFua2xydGVzdDIrQGdtYWlsLmNvbSIsImV4cCI6MTc0NTQ4MzA4MSwiZmlyc3RuYW1lIjoiTWF5YW5rIiwiaWF0IjoxNzQ1NDgxMjgxLCJpc3MiOiJodHRwczovL2ludGVybmFsLW1heWFuay5odWIubG9naW5yYWRpdXMuY29tLyIsImp0aSI6IjlhNGZkOGY1LWU4NDMtNDgzZS1hODNiLTJlNTM4NzY5ZTYxNiIsImxhc3RuYW1lIjoiQWdhcndhbCIsIm5iZiI6MTc0NTQ4MTI4MSwic3ViIjoiMWFjM2Q5ZGMzYzdkNDJlMDhhMzJiZjU0NjIyYmNjYzMifQ.m88HgYiikjAJju5mKeqJLgdEbqoAGGLVGLhxmB81jWc"
}

{
  "Description": "A potentially dangerous request value was detected.",
  "ErrorCode": 1214,
  "Message": "Dangerous request"
}

{
  "Description": "The JWT configuration not found or the resource does not exist.",
  "ErrorCode": 1180,
  "Message": "JWT configuration not found."
}

{
  "Description": "The provided account is not allowed to login, please reach out to LoginRadius support for more information.",
  "ErrorCode": 1220,
  "Message": "Account is not allowed to login"
}

Retrieve JWT token

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

Example DANGEROUS_REQUEST

Example EMAIL_PAYLOAD_REQUIRED

Example EMAILID_ID_FORMAT_NOT_VALID

Example INVALID_HOST

Example INVALID_PHONE_NUMBER

Example INVALID_POST_BODY

Example JWT_APP_NAME_REQUIRED

Example JWT_APP_NOT_MATCHED

Example PASSWORD_EMAIL_PAYLOAD_REQUIRED

Example PASSWORD_PAYLOAD_REQUIRED

Example PASSWORD_PHONE_PAYLOAD_REQUIRED

Example PASSWORD_USERNAME_PAYLOAD_REQUIRED

Example PHONE_OR_EMAIL_OR_USER_REQUIRED_PARAM

Example PHONE_PAYLOAD_REQUIRED

Example POST_BODY_INVALID

Example USERNAME_PAYLOAD_REQUIRED

Example JWT_CONFIG_NOT_FOUND

Example JWT_CONFIG_NOT_VALID

Example USERNAME_OR_PASSWORD_WRONG

USERNAME_OR_PASSWORD_WRONG_FOR_BLOCK_LOCKOUT

USERNAME_OR_PASSWORD_WRONG_FOR_SUSPEND_LOCKOUT

GENERIC_AUTH_ERROR

Example ACCOUNT_NOT_ALLOWED_TO_LOGIN

Example ACTIVE_SESSIONS_EXCEEDED

Example API_KEY_NOT_VALID

Example APP_DOESNT_HAVE_PERMISSION_TO_ACCESS_THIS_ENDPOINT

Example APP_NOT_EXISTS

Example BREACHED_PASSWORD_LOGIN

Example CAPTCHA_NOT_VALID

Example CHANGE_BREACHED_PASSWORD

Example CONSENT_FORM_NOT_SUBMITTED

Example CONSENT_FORM_VALIDATION_FAILED

Example EMAIL_NOT_VERIFIED

Example EMAIL_SEND_LIMIT_REACHED

Example EMAIl_OR_PHONE_NUMBER_REQUIRED_VERIFIED

Example LOGIN_DISABLED

Example LOGIN_IS_LOCKED_FOR_RECAPTCHA

Example LOGIN_IS_LOCKED_FOR_SECURITY_QUESTION

Example LOGIN_WITH_PASSWORD_NOT_ENABLED

Example OPERATION_FAILED

Example OTP_SEND_FAILED

Example PHONE_NO_LOGIN_NOT_ENABLED

Example PHONE_NOT_VERIFIED

Example PIN_IS_REQUIRED

Example PRIVACY_POLICY_MISMATCHED

Example RBA_ACCOUNT_IS_BLOCKED

Example RBA_EMAIL_VERIFICATION

Example RBA_SECURITY_ANSWER_VERIFICATION

Example RBA_SMS_VERIFICATION

Example SMS_CONFIGURATION_NOT_EXISTS

Example SMS_SEND_LIMIT_REACHED

Example TRIAL_PLAN_EXPIRED

Example USER_ID_BLOCKED

Example USER_ID_LOCKED_SSO

Example USER_ID_LOCKED_WITH_TIMEOUT_SSO

Example USER_NAME_AUTHENTICATION_ENABLED_SSO

Example USER_NOT_EXISTS_SSO

`application/json`

`application/json`

`application/json`

`application/json`