Create a new personal access token (PAT) for the current user.

POST 
<your-unleash-url>/api/admin/user/tokens

Creates a new [personal access token](https://docs.getunleash.io/reference/api-tokens-and-client-keys#personal-access-tokens (PAT) belonging to the current user.

Request

application/json

Bodyrequired

#/components/schemas/createPatSchema

descriptionstringrequired
The PAT's description.
Example: user:xyzrandomstring
expiresAtdate-timerequired
The PAT's expiration date.
Example: 2023-04-19T08:15:14.000Z

Responses

201

The resource was successfully created.

Response Headers

location

The location of the newly created resource.

application/json

Schema

Schema

idintegerrequired
The PAT's ID. PAT IDs are incrementing integers. In other words, a more recently created PAT will always have a higher ID than an older one.
Possible values: >= 1
Example: 1
secretstring
The token used for authentication. It is automatically generated by Unleash when the PAT is created and that is the only time this property is returned.
Example: user:xyzrandomstring
createdAtdate-timerequired
The date and time of when the PAT was created.
Example: 2023-04-19T08:15:14.000Z
seenAtdate-timenullable
When the PAT was last seen/used to authenticate with. null if it has not been used yet.
Example: 2023-04-19T08:15:14.000Z
userIdinteger
The ID of the user this PAT belongs to.
Example: 1337
descriptionstringrequired
The PAT's description.
Example: user:xyzrandomstring
expiresAtdate-timerequired
The PAT's expiration date.
Example: 2023-04-19T08:15:14.000Z

Example (auto)

{
  "id": 1,
  "secret": "user:xyzrandomstring",
  "createdAt": "2023-04-19T08:15:14.000Z",
  "seenAt": "2023-04-19T08:15:14.000Z",
  "userId": 1337,
  "description": "user:xyzrandomstring",
  "expiresAt": "2023-04-19T08:15:14.000Z"
}

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

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
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 (auto)

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

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

Example (auto)

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

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '<your-unleash-url>/api/admin/user/tokens' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-d '{
  "description": "user:xyzrandomstring",
  "expiresAt": "2023-04-19T08:15:14.000Z"
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Body required

{
  "description": "user:xyzrandomstring",
  "expiresAt": "2023-04-19T08:15:14.000Z"
}

ResponseClear

Click the Send API Request button above and see the response here!