Developer docs
/
Rebilly API
/
Customer authentication
/
Retrieve authentication tokens

Retrieve authentication tokens

Retrieves a list of customer authentication tokens.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

get
/authentication-tokens
Request samples
$authenticationTokens = $client->authenticationTokens()->search([
    'filter' => 'customerId:testCustomer',
]);
Responses

200

List of auth tokens retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
username
required
string

Username of the customer who is associated with the authentication token.

customerId
string <= 50 characters

ID of the customer resource.

token
string

ID of the authentication token.

otpRequired
boolean

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

credentialId
string (ResourceId) <= 50 characters

Unique resource ID.

expiredTime
string or null <date-time>

Date and time when the token expired.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

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",

}
]