List tokens for a provided API ID and OAuth-client ID

This endpoint allows you to retrieve a list of all current tokens and their expiry date for a provided API ID and OAuth-client ID .If page query parameter is sent the tokens will be paginated. This endpoint will work only for newly created tokens.

You can control how long you want to store expired tokens in this list using oauth_token_expired_retain_period gateway option, which specifies retain period for expired tokens stored in Redis. By default expired token not get removed. See here for more details.

GET /tyk/oauth/clients/{apiID}/{keyName}/tokens

Try it

List tokens for a provided API ID and OAuth-client ID

cURL

curl --request GET \
  --url https://{tenant}/tyk/oauth/clients/{apiID}/{keyName}/tokens \
  --header 'X-Tyk-Authorization: <api-key>'

200

{
  "Pagination": {
    "page_num": 123,
    "page_size": 123,
    "page_total": 123
  },
  "Tokens": [
    {
      "code": "<string>",
      "expires": 123
    }
  ]
}

Authorizations

X-Tyk-Authorization · string · header · required

Api key

Path Parameters

apiID · string · required

The API id

keyName · string · required

The Client ID

Query Parameters

page · integer · default: 1

Use page query parameter to say which page number you want returned.

Response

200

application/json

object | object[] | null

Tokens returned successfully.

object

object[]

Pagination · object

Show child attributes

Pagination. page_num · integer

Pagination. page_size · integer

Pagination. page_total · integer

Tokens · object[] | null

Show child attributes

Tokens. code · string

Tokens. expires · integer