Developer docs
/
Rebilly API
/
Customer authentication
/
Login a customer

Login a customer

Logs in a customer.

SecurityAPI Key: SecretApiKey or HTTP: JWT or API Key: PublishableApiKey
Request
Request Body schema: application/json
required

AuthenticationToken resource.

username
required
string

Username associated with the authentication token.

password
required
string <password>

Password associated with the authentication token.

mode
string

Specifies the authentication verification method. The password token requires the user to enter a password to log in. The passwordless token, requires a secret API key to log in. To obtain an API key, see Manage API keys.

otpRequired
boolean

Specifies if a One-Time Password (OTP) is required to exchange the authentication token.

expiredTime
string <date-time>

Date and time when the token expired.

post
/authentication-tokens
Request samples
application/json
{
"username": "string",
"password": "pa$$word",
"mode": "password",
"otpRequired": true,
"credentialId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"expiredTime": "2019-08-24T14:15:22Z"
}
Responses

201

Login successful.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

Response samples
application/json
{
"username": "string",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"token": "string",
"otpRequired": true,
"credentialId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"expiredTime": "2019-08-24T14:15:22Z",
"_links": [

]
}