# Update access token


[API catalog](/reference/api/) · [Docker Hub overview](/reference/api/hub/latest/) · [Product manual](https://docs.docker.com/docker-hub/) · [OpenAPI specification](/reference/api/hub/latest.yaml)

API version: 2-beta



`PATCH /v2/orgs/{org_name}/access-tokens/{access_token_id}`

Update a specific access token for an organization.


## Connection and access

[API connection and authentication guidance](/reference/api/hub/latest/#authentication)


Server: `https://hub.docker.com`

Effective security: alternatives are OR; schemes within an alternative are AND. An empty array declares no HTTP authentication requirement.

```json
[
  {
    "bearerAuth": []
  }
]
```
## Example request

Replace placeholders and provide the required credentials or request body.

```console
curl \
  --request PATCH \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "description": "Token for CI/CD pipeline",
  "is_active": true,
  "label": "My organization token",
  "resources": [
    {
      "path": "myorg/myrepo",
      "scopes": [
        "scope-image-pull"
      ],
      "type": "TYPE_REPO"
    }
  ]
}' \
  'https://hub.docker.com/v2/orgs/myorganization/access-tokens/a7a5ef25-8889-43a0-8cc7-f2a94268e861'
```

## Parameters

### org_name

Location: path. Required: yes.

Name of the organization (namespace).

```json
{
  "description": "Name of the organization (namespace).",
  "example": "myorganization",
  "in": "path",
  "name": "org_name",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens~1{access_token_id}/parameters/0",
  "required": true,
  "schema": {
    "type": "string"
  }
}
```

### access_token_id

Location: path. Required: yes.

The ID of the access token to retrieve

```json
{
  "description": "The ID of the access token to retrieve",
  "example": "a7a5ef25-8889-43a0-8cc7-f2a94268e861",
  "in": "path",
  "name": "access_token_id",
  "pointer": "/paths/~1v2~1orgs~1{org_name}~1access-tokens~1{access_token_id}/parameters/1",
  "required": true,
  "schema": {
    "type": "string"
  }
}
```

## Request and responses

### Request  application/json




Schema:

```json
{
  "$ref": "#/components/schemas/updateOrgAccessTokenRequest"
}
```




Schema example:
```json
{
  "description": "Token for CI/CD pipeline",
  "is_active": true,
  "label": "My organization token",
  "resources": [
    {
      "path": "myorg/myrepo",
      "scopes": [
        "scope-image-pull"
      ],
      "type": "TYPE_REPO"
    }
  ]
}
```


### Response 200 application/json

OK


Schema:

```json
{
  "$ref": "#/components/schemas/updateOrgAccessTokenResponse"
}
```




Schema example:
```json
{
  "created_at": "2022-05-20T00:54:18Z",
  "created_by": "johndoe",
  "expires_at": "2023-05-20T00:54:18Z",
  "id": "a7a5ef25-8889-43a0-8cc7-f2a94268e861",
  "is_active": true,
  "label": "My organization token",
  "last_used_at": "2022-06-15T12:30:45Z",
  "resources": [
    {
      "path": "myorg/myrepo",
      "scopes": [
        "scope-image-pull"
      ],
      "type": "TYPE_REPO"
    }
  ]
}
```


### Response 401 application/json

Unauthorized


Schema:

```json
{
  "$ref": "#/components/schemas/error"
}
```




error:
```json
{
  "errinfo": null,
  "message": "unauthorized"
}
```


### Response 403 application/json

Forbidden


Schema:

```json
{
  "$ref": "#/components/schemas/error"
}
```




error:
```json
{
  "errinfo": null,
  "message": "permission denied"
}
```


### Response 404 application/json

Not Found


Schema:

```json
{
  "$ref": "#/components/schemas/error"
}
```




error:
```json
{
  "errinfo": null,
  "message": "not found"
}
```


## Complete operation contract

```json
{
  "description": "Update a specific access token for an organization.\n",
  "operationId": "patchV2OrgsByOrgNameAccessTokensByAccessTokenId",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/updateOrgAccessTokenRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/updateOrgAccessTokenResponse"
          }
        }
      },
      "description": "OK"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "summary": "Update access token",
  "tags": [
    "org-access-tokens"
  ]
}
```

## Referenced schemas

- `#/components/responses/Forbidden`

- `#/components/responses/NotFound`

- `#/components/responses/Unauthorized`

- [#/components/schemas/updateOrgAccessTokenRequest](/reference/api/hub/latest/schemas/updateOrgAccessTokenRequest/)

- [#/components/schemas/updateOrgAccessTokenResponse](/reference/api/hub/latest/schemas/updateOrgAccessTokenResponse/)