Patch access token

PATCH

/api/v2/tokens/:id

PATCH

/api/v2/tokens/:id

$ curl -X PATCH https://app.launchdarkly.com/api/v2/tokens/id \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '[
>   {
>     "op": "replace",
>     "path": "/role",
>     "value": null
>   }
> ]'

1 {
2   "_id": "61095542756dba551110ae21",
3   "ownerId": "569f514156e003339cfd3917",
4   "memberId": "569f514183f2164430000002",
5   "creationDate": 1628001602644,
6   "lastModified": 1628001602644,
7   "_links": {
8     "parent": {
9       "href": "/api/v2/tokens",
10       "type": "application/json"
11     },
12     "self": {
13       "href": "/api/v2/tokens/61095542756dba551110ae21",
14       "type": "application/json"
15     }
16   },
17   "_member": {
18     "_links": {
19       "self": {
20         "href": "/api/v2/members/569f183514f4432160000007",
21         "type": "application/json"
22       }
23     },
24     "_id": "569f183514f4432160000007",
25     "role": "admin",
26     "email": "ariel@acme.com",
27     "firstName": "Ariel",
28     "lastName": "Flores"
29   },
30   "name": "Example reader token",
31   "description": "A reader token used in testing and examples",
32   "customRoleIds": [],
33   "inlineRole": [],
34   "role": "reader",
35   "token": "1234",
36   "serviceToken": false,
37   "defaultApiVersion": 20240415,
38   "lastUsed": 0
39 }

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

Update an access token's settings. Updating an access token uses a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequiredformat: "string"

The ID of the access token to update

Request

This endpoint expects a list of objects.

Response

Access token response

_idstring

The ID of the access token

ownerIdstring

The ID of the owner of the account for the access token

memberIdstring

The ID of the member who created the access token

creationDatelong

Timestamp of when the access token was created

lastModifiedlong

Timestamp of the last modification of the access token

_linksmap from strings to objects

The location and content type of related resources

_memberobjectOptional

Details on the member who created the access token

namestringOptional

A human-friendly name for the access token

descriptionstringOptional

A description for the access token

customRoleIdslist of stringsOptional

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

inlineRolelist of objectsOptional

An array of policy statements, with three attributes: effect, resources, actions. May be used in place of a role.

rolestringOptional

Base role for the token

tokenstringOptional

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

serviceTokenbooleanOptional

Whether this is a service token or a personal token

defaultApiVersionintegerOptional

The default API version for this token

lastUsedlongOptional

Timestamp of when the access token was last used

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error