Create a project API token.

POST /api/admin/projects/:projectId/api-tokens

Endpoint that allows creation of project API tokens for the specified project.

Request

Path Parameters

• projectId string required

application/json

Body

required

createApiTokenSchema

oneOf

MOD1

expiresAt date-time

The time when this token should expire.

type string required

Possible values: Value must match regular expression ^[Aa][Dd][Mm][Ii][Nn]$

An admin token. Must be the string "admin" (not case sensitive).

tokenName string required

The name of the token.

MOD2

expiresAt date-time

The time when this token should expire.

type string required

Possible values: Value must match regular expression ^[Aa][Dd][Mm][Ii][Nn]$

An admin token. Must be the string "admin" (not case sensitive).

username string deprecated

The name of the token. This property is deprecated. Use tokenName instead.

MOD3

expiresAt date-time

The time when this token should expire.

type string required

Possible values: Value must match regular expression ^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$

A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive).

environment string

The environment that the token should be valid for. Defaults to "default"

project string

The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the projects property. If you specify one, you cannot specify the other.

projects string[]

A list of projects that the token should be valid for. This property is mutually incompatible with the project property. If you specify one, you cannot specify the other.

tokenName string required

The name of the token.

MOD4

expiresAt date-time

The time when this token should expire.

type string required

Possible values: Value must match regular expression ^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$

A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive).

environment string

The environment that the token should be valid for. Defaults to "default"

project string

The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the projects property. If you specify one, you cannot specify the other.

projects string[]

A list of projects that the token should be valid for. This property is mutually incompatible with the project property. If you specify one, you cannot specify the other.

username string deprecated

The name of the token. This property is deprecated. Use tokenName instead.

Responses

• 201
• 400
• 401
• 403
• 404

---

The resource was successfully created.

Response Headers

• location string

  The location of the newly created resource.

application/json

Schema

Schema

• secret string required

  The token used for authentication.

• username string deprecated

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

• tokenName string required

  A unique name for this particular token

• type string required

  Possible values: [client, admin, frontend]

  The type of API token

• environment string

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

• project string required

  The project this token belongs to.

• 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 [*]

• expiresAt date-time nullable

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

• createdAt date-time required

  When the token was created.

• seenAt date-time nullable

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

• alias string nullable

  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 (from schema)

{
  "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"
}

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

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

• name string

  The name of the error kind

• message string

  A description of what went wrong.

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."
}

The requested resource was not found.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...