Get API tokens by name

GET 
/api/admin/api-tokens/:name

Retrieves all API tokens that match a given token name. Because token names are not unique, this endpoint will always return a list. If no tokens with the provided name exist, the list will be empty. Otherwise, it will contain all the tokens with the given name.

Request

Path Parameters

name stringrequired

Responses

200

apiTokensSchema

application/json

Schema

Schema

tokens

object[]

required

A list of Unleash API tokens.

Array [

secret stringrequired

The token used for authentication.

Example: project:environment.xyzrandomstring

username stringdeprecated

This property was deprecated in Unleash v5. Prefer the tokenName property instead.

Example: a-name

tokenName stringrequired

A unique name for this particular token

Example: some-user

type stringrequired

The type of API token

Possible values: [client, admin, frontend]

Example: client

environment string

The environment the token has access to. * if it has access to all environments.

Example: development

project stringrequired

The project this token belongs to.

Example: developerexperience

projects string[]required

The list of projects this token has access to. If the token has access to specific projects they will be listed here. If the token has access to all projects it will be represented as [*]

Example: ["developerexperience","enterprisegrowth"]

expiresAt date-timenullable

The token's expiration date. NULL if the token doesn't have an expiration set.

Example: 2023-04-19T08:15:14.000Z

createdAt date-timerequired

When the token was created.

Example: 2023-04-19T08:15:14.000Z

seenAt date-timenullable

When the token was last seen/used to authenticate with. NULL if the token has not yet been used for authentication.

Example: 2023-04-19T08:15:14.000Z

alias stringnullable

Alias is no longer in active use and will often be NULL. It's kept around as a way of allowing old proxy tokens created with the old metadata format to keep working.

Example: randomid-or-some-alias

]

Example (from schema)

{
  "tokens": [
    {
      "secret": "project:environment.xyzrandomstring",
      "tokenName": "some-user",
      "type": "client",
      "environment": "development",
      "project": "developerexperience",
      "projects": [
        "developerexperience",
        "enterprisegrowth"
      ],
      "expiresAt": "2023-04-19T08:15:14.000Z",
      "createdAt": "2023-04-19T08:15:14.000Z",
      "seenAt": "2023-04-19T08:15:14.000Z",
      "alias": "randomid-or-some-alias"
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Loading...