Retrieve a list of auth tokens

Retrieves a list of customer authentication tokens.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

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

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

Customer resource ID. Defaults to UUID v4.

token
string

Authentication token identifier string.

otpRequired
boolean

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

credentialId
string <= 50 characters

ID of the user associated with the authentication token.

expiredTime
string <date-time>

Date and time at which the token expired.

Array of objects (Self) non-empty

Related resource links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/authentication-tokens
Request samples
$authenticationTokens = $client->authenticationTokens()->search([
    'filter' => 'customerId:testCustomer',
]);
Response samples
application/json
[
  • {
    }
]