> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/auth/token/revoke

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/auth/token/revoke
```

## Supported methods and overview&#x20;

* `POST` - used to revoke (i.e. invalidate) an [access token](/3.1/api/authentication-and-authorization.md) as well as its associated refresh token.

## Detailed description&#x20;

This API endpoint invalidates the access token passed in the [header](/3.1/api/access-service-api-v1-auth-token-revoke.md#access-service-api-v1-auth-token-revoke-required-headers) of the request to this endpoint (including the header of requests to any other of Covata's API endpoints).

If this request succeeds, both this access token and its associated refresh token are invalidated. Passing any invalidated access token in the header of requests to any Covata API endpoint will cause these requests to fail.

It is also possible to invalidate all access tokens (and their associated refresh tokens) that belong to one or more [Covata user(s)](/3.1/admin/administering-users.md) by calling the [\<access-service>/api/v1/users/\{userId}/expire](/3.1/api/access-service-api-v1-users-userid-expire.md) or [\<access-service>/api/v1/users/bulk](/3.1/api/access-service-api-v1-users-bulk.md) API endpoints, respectively.

## Supported roles&#x20;

This API endpoint supports the following Covata user [roles](/3.1/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/3.1/admin.md)):

* [Originator](/3.1/admin/administering-users.md#originator-role)
* [Collaborator](/3.1/admin/administering-users.md#collaborator-role)
* [Ad hoc](/3.1/admin/administering-users.md#adhoc-role)
* [System administrator](/3.1/admin/administering-users.md#system-administrator-role)
* [User administrator](/3.1/admin/administering-users.md#user-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/3.1/api/access-service-api-v1-auth-token-revoke.md#access-service-api-v1-auth-token-revoke-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6`

The request also requires form URL-encoded data in the body:

* `Content-Type: application/x-www-form-urlencoded`

## Required parameters&#x20;

The following required parameter must be sent in the body of the request (as form URL-encoded data):

* **token** - The access token passed in the [header](/3.1/api/access-service-api-v1-auth-token-revoke.md#access-service-api-v1-auth-token-revoke-required-headers) of the request to this endpoint.

  **Example:**

  ```text theme={null}
  token=a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6
  ```

## Returns&#x20;

If the request succeeded, then an HTTP response status `200 OK` is returned.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.