Get all personal access tokens (PATs) for the current user.

GET 
/api/admin/user/tokens

Returns all of the personal access tokens (PATs) belonging to the current user.

Responses

200

#/components/schemas/patsSchema

application/json

Schema

Schema

pats

object[]

A collection of PATs.

Array [

id integerrequired

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

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.

Example: user:xyzrandomstring

createdAt date-timerequired

The date and time of when the PAT was created.

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

seenAt date-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

userId integer

The ID of the user this PAT belongs to.

Example: 1337

description stringrequired

The PAT's description.

Example: user:xyzrandomstring

expiresAt date-timerequired

The PAT's expiration date.

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

]

Example (from schema)

{
  "pats": [
    {
      "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

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

404

The requested resource was not found.

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: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

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

Loading...