v13

latestOpenAPI 3.0.32026-07-31359869.4 MB

authentication

Create an Auth Token

Creates and returns a new authentication token for the currently authenticated User. The bearerToken property is only provided once, in the response body, so be sure to save it on the client for use with API requests.

post/v3/user/tokens

Query parameters

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

namestring required

expiresAtnumber

projectIdstring

The ID of the project to scope this token to

Response

Successful response.

bearerTokenstring required

The authentication token's actual value. This token is only provided in this response, and can never be retrieved again in the future. Be sure to save it somewhere safe!

Example response

{
  "token": {
    "id": "5d9f2ebd38ddca62e5d51e9c1704c72530bdc8bfdd41e782a6687c48399e8391",
    "type": "oauth2-token",
    "prefix": "vcp_",
    "suffix": "abc123",
    "origin": "github",
    "createdAt": 1632816536002,
    "activeAt": 1632816536002,
    "expiresAt": 1632816536002,
    "revokedAt": 1632816536002,
    "leakedAt": 1632816536002
  },
  "bearerToken": "uRKJSTt0L4RaSkiMj41QTkxM"
}