Skip to content
Docs
Select language:English

/api/v1/tokens/{id} (PATCH)

PATCH
/api/v1/tokens/{id}
curl --request PATCH \
  --url https://example.com/api/v1/tokens/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
Examplegenerated
{
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
Allowed values: personal oauth
name
required
string
scope
required
string
Allowed values: read write
locations
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
kind
required
string
createdAt
required
string
expiresAt
required
string | null
lastUsedAt
required
string | null
revokedAt
required
string | null
revokedReason
required
Any of:
string
Allowed values: user membership_ended role_lost expired admin client_revoked account_claimed
clientName
string
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "kind": "personal",
  "scope": "read",
  "revokedReason": "user"
}