Add

POST
/user
/tokens

Adds a new personal access token.

Warning

You can't create tokens with scopes higher than those in the authorization token.

Hint

If there are any IP or workspace restrictions saved in the authorization token, they will be copied to the created token. If you want to change the restrictions, an authorization token without restrictions must be used.

Request

REQUIRED SCOPES

TOKEN_MANAGE

POST PARAMETERS

namerequired string

The token name.

expires_ininteger

Specifies the number of days in which the access token expires. Once specified, expires_at can't be set.

expires_atDateTime

Specifies the expiration period for the token. Once specified, expires_in can't be set.

scopesstring[]

The list of scopes for the created token. All scopes are available here.

ip_restrictionsstring[]

The list of IP addresses for which the token will be restricted (wildcards are supported).

workspace_restrictionsstring[]

The list of workspaces in which the token can be used. A domain must be provided, not workspace name.

Last modified on Sep 23, 2024

Delete Get token by ID

Example:

curl -X POST "https://api.buddy.works/user/tokens" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "My test token",
  "expires_in": 7,
  "scopes": [
    "WORKSPACE"
  ],
  "ip_restrictions": [
    "123.123.123.123"
  ],
  "workspace_restrictions": [
    "buddy"
  ]
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/user/tokens/ZGU2Mk5ODItMTczYy00MThkLWJiOGtNmJmzFjMWVlYjAy",
  "html_url": "https://app.buddy.works/api-tokens/details/ZGU2Mk5ODItMTczYy00MThkLWJiOGtNmJmzFjMWVlYjAy",
  "id": "ZGU2Mk5ODItMTczYy00MThkLWJiOGtNmJmzFjMWVlYjAy",
  "name": "My test token",
  "token": "ed0f8927-c116-4afe-b555-c888dfd86c92",
  "expires_at": "2023-03-28T13:46:39.238118Z",
  "scopes": [
    "WORKSPACE"
  ],
  "ip_restrictions": [
    "123.123.123.123"
  ],
  "workspace_restrictions": [
    "buddy"
  ]
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999