---
title: "Update Agent Access Token"
method: PATCH
path: "/api/v2/AgentAccessTokens/{id}"
tags: ["AgentAccessTokens"]
---

# Update Agent Access Token

`PATCH /api/v2/AgentAccessTokens/{id}`

Optionally update the `tokenEnabled` settings of the passed in agent access token. Update these settings by invoking the following endpoint:

  > `PATCH https://YourAccount.lacework.net/api/v2/AgentAccessTokens/{id}`

  Get the agent access token id by calling the `GET /api/v2/AgentAccessTokens` endpoint.

  Replace `{id}` with the long hexadecimal access token identifier returned in the `accessToken` field of the `GET /api/v2/AgentAccessTokens` endpoint response.

  Here is an example `body` payload:

  > `{ "tokenEnabled": "1" }`

## Path parameters

- `id` string, required

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Request body

- AgentAccessTokensUpdateSchema
  - `props` object — The access token's properties, including `createdTime` and `description`.
    - `description` string — A brief description of the token creation.
    - `os` string — The operating system.
    - `subscription` 'standard' | 'professional' | 'enterprise' — The subscription level of the token.
  - `tokenEnabled` string — The `tokenEnabled` property determines if an edit control is a "Text token" edit control. When the `tokenEnabled` property is set to `1`, if the user enters a separator character or a carriage return (CR), a token is automatically added and the user can continue entering values in the control.

## Response `200`

No Error

- object
  - `data` AgentAccessTokensResponseSchema
    - `props` object — The access token's properties, including `createdTime` and `description`.
      - `description` string — A brief description of the token creation.
      - `os` string — The operating system.
      - `subscription` 'standard' | 'professional' | 'enterprise' — The subscription level of the token.
    - `tokenEnabled` string, required — The `tokenEnabled` property determines if an edit control is a "Text token" edit control. When the `tokenEnabled` property is set to `1`, if the user enters a separator character or a carriage return (CR), a token is automatically added and the user can continue entering values in the control.
    - `tokenAlias` string, required — The token's alias such as Ops Agent. Aliases help communicate the intended purpose of a token and are effective when a value with a single intent appears in multiple places.
    - `accessToken` string — The new agent access token.
    - `createdTime` string — The time and date when the token was issued by FortiCNAPP.
    - `version` string — The FortiCNAPP Agent's version.

## Other responses

- `4XX` — Client Error
- `5XX` — Internal Server Error

---

[API](https://skmtc.net/lacework/apis/forticnapp-api-2-0-documentation.md) · [All operations](https://skmtc.net/lacework/apis/forticnapp-api-2-0-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lacework/forticnapp-api-2-0-documentation/revisions/7015f76895f2/schema)