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

# Revoke a token

> Revokes one of your tokens at once. A realm admin may also revoke a realm token of their realm by sending `realm_id`.

Requires a signed-in user token (`Authorization: Bearer cliq_tok_…`). Results are limited to what that user can see. Own tokens only.



## OpenAPI

````yaml /openapi/hub-by-tag/hub-auth.yaml post /v1/auth/revoke_token
openapi: 3.0.3
info:
  title: 'CliqHub API: Auth'
  version: 1.0.0
  description: >-
    API tokens. Every call to CliqHub carries one as `Authorization: Bearer
    <token>`:


    - **User token** (`cliq_tok_…`): acts as you, optionally limited by
    `permissions` (which
      organizations and realms, and read / write / admin per kind of resource). `cliq login`
      stores one; mint more for scripts and CI.
    - **Realm token** (`cliq_dt_…`): what a daemon uses to join and work in a
    realm. Any
      member of the realm can mint one.
    - **A2A token** (`cliq_a2a_…`): what outside agents send to a realm's A2A
    endpoint. One per
      realm; minting a new one replaces the old.
    - **Dispatch token**: a short-lived signed token CliqHub uses when it sends
    work to a
      daemon; each realm has a dispatch key pair for it.

    A token is shown only when it is minted or rotated. A restricted token
    cannot mint a token

    wider than itself.
servers:
  - url: https://{host}
    variables:
      host:
        default: cliqhub.io
        description: CliqHub host
security: []
tags:
  - name: Auth
    description: >-
      API tokens. Every call to CliqHub carries one as `Authorization: Bearer
      <token>`:


      - **User token** (`cliq_tok_…`): acts as you, optionally limited by
      `permissions` (which
        organizations and realms, and read / write / admin per kind of resource). `cliq login`
        stores one; mint more for scripts and CI.
      - **Realm token** (`cliq_dt_…`): what a daemon uses to join and work in a
      realm. Any
        member of the realm can mint one.
      - **A2A token** (`cliq_a2a_…`): what outside agents send to a realm's A2A
      endpoint. One per
        realm; minting a new one replaces the old.
      - **Dispatch token**: a short-lived signed token CliqHub uses when it
      sends work to a
        daemon; each realm has a dispatch key pair for it.

      A token is shown only when it is minted or rotated. A restricted token
      cannot mint a token

      wider than itself.
paths:
  /v1/auth/revoke_token:
    post:
      tags:
        - Auth
      summary: Revoke a token
      description: >-
        Revokes one of your tokens at once. A realm admin may also revoke a
        realm token of their realm by sending `realm_id`.


        Requires a signed-in user token (`Authorization: Bearer cliq_tok_…`).
        Results are limited to what that user can see. Own tokens only.
      operationId: POST_v1_auth_revoke_token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - user
                    - realm
                    - daemon
                  description: Must match the stored token type
                token_id:
                  oneOf:
                    - type: string
                      minLength: 1
                    - type: integer
                  description: The token's id.
                realm_id:
                  type: string
                  minLength: 1
                  description: >-
                    Realm admin may revoke a realm token they do not own when
                    this is set
              required:
                - type
                - token_id
            examples:
              default:
                value:
                  type: user
                  token_id: '42'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                properties:
                  ok:
                    type: boolean
                    enum:
                      - true
                    description: Always `true` on success.
                  data:
                    type: object
                    properties:
                      revoked:
                        type: boolean
                        enum:
                          - true
                      type:
                        type: string
              example:
                ok: true
                data:
                  revoked: true
                  type: user
        '401':
          description: >-
            `unauthorized`: No `Authorization` header, or the token is
            malformed, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                unauthorized:
                  summary: unauthorized
                  value:
                    ok: false
                    error:
                      code: unauthorized
                      message: Authentication required
        '403':
          description: >-
            `forbidden`: A daemon token was used; this route needs a user token.


            `forbidden`: The token is not yours and you are not revoking a realm
            token as that realm's admin.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                forbidden:
                  summary: forbidden
                  value:
                    ok: false
                    error:
                      code: forbidden
                      message: You do not have access to do this
                forbidden (endpoint):
                  summary: forbidden (endpoint)
                  value:
                    ok: false
                    error: Not your token
                    code: forbidden
        '404':
          description: >-
            `not_found`: No such token, it is already revoked, it is of another
            `type`, or it is not in `realm_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                not_found:
                  summary: not_found
                  value:
                    ok: false
                    error: Token not found
                    code: not_found
        '422':
          description: >-
            `invalid_params`: The body fails the request schema: a required
            field is missing or a value has the wrong type or format. The
            message lists every issue as `field: problem`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                invalid_params:
                  summary: invalid_params
                  value:
                    ok: false
                    error: 'type: Required'
                    code: invalid_params
        '500':
          description: >-
            `internal_error`: An unexpected server fault. Retry later; if it
            persists, report it with the time of the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubErr'
              examples:
                internal_error:
                  summary: internal_error
                  value:
                    ok: false
                    error: Internal server error
                    code: internal_error
      security:
        - BearerAuth: []
components:
  schemas:
    HubErr:
      type: object
      required:
        - ok
        - error
      description: >-
        Every failure. Route-policy denials (401/403/404, and 400 when neither
        realm_id nor org_id was sent) answer `error` as `{ code, message }`;
        errors raised by the endpoint answer `error` as the message with the
        code beside it in `code`. Every error has a code. See
        [Errors](/hub-api/errors).
      properties:
        ok:
          type: boolean
          description: Always false on error
        error:
          description: The message, or `{ code, message }` for an access denial.
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
        code:
          type: string
          description: Stable error code of an endpoint error.
        details:
          type: object
          additionalProperties: true
          description: Structured detail, when there is some.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cliq_tok_* | cliq_dt_*
      description: >-
        User PAT (`cliq_tok_…`, including session-scoped) or realm token
        (`cliq_dt_…`).

````

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