Create a new personal access token (PAT) for the current user.
POST /api/admin/user/tokens
Creates a new personal access token (PAT) belonging to the current user.
Request
- application/json
Body
required
#/components/schemas/createPatSchema
- description string required
The PAT's description.
- expiresAt date-time required
The PAT's expiration date.
- 201
- 401
- 403
- 404
The resource was successfully created.
Response Headers
location string
The location of the newly created resource.
- application/json
- Schema
- Example (from schema)
Schema
- id integer required
Possible values:
>= 1
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.
- secret string
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.
- createdAt date-time required
The date and time of when the PAT was created.
- seenAt date-time nullable
When the PAT was last seen/used to authenticate with.
null
if it has not been used yet. - userId integer
The ID of the user this PAT belongs to.
- description string required
The PAT's description.
- expiresAt date-time required
The PAT's expiration date.
{
"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"
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from 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.
{
"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
- Example (from 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.
{
"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
- Example (from 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.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}