Sign in

v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
Access tokens

Patch access token

Update an access token's settings. Updating an access token uses a JSON patch representation of the desired changes. To learn more, read Updates.

patch/api/v2/tokens/{id}

Path parameters

idstring string required

The ID of the access token to update

The ID of the access token to update

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Access token response

_idstring required
ownerIdstring required
memberIdstring required
namestring

A human-friendly name for the access token

descriptionstring

A description for the access token

creationDateinteger required
lastModifiedinteger required
customRoleIdsObjectId[]

A list of custom role IDs to use as access limits for the access token

rolestring

Base role for the token

tokenstring

The token value. When creating or resetting, contains the entire token value. Otherwise, contains the last four characters.

serviceTokenboolean

Whether this is a service token or a personal token

_linksobject required

The location and content type of related resources

defaultApiVersioninteger

The default API version for this token

lastUsedinteger

Example response

{
  "_member": {
    "_links": {
      "self": {
        "href": "/api/v2/members/569f183514f4432160000007",
        "type": "application/json"
      }
    },
    "_id": "569f183514f4432160000007",
    "firstName": "Ariel",
    "lastName": "Flores",
    "role": "admin",
    "email": "ariel@acme.com"
  },
  "name": "Example reader token",
  "description": "A reader token used in testing and examples",
  "customRoleIds": [],
  "inlineRole": [],
  "role": "reader",
  "token": "1234",
  "_links": {
    "parent": {
      "href": "/api/v2/tokens",
      "type": "application/json"
    },
    "self": {
      "href": "/api/v2/tokens/61095542756dba551110ae21",
      "type": "application/json"
    }
  },
  "defaultApiVersion": 20240415
}