Token delete

Revoke a session token for a principal (DELETE /v1/token?principal=…&token=…). Success returns 204 with no body.

DELETE
{{host}}/v1/token?principal={{principal}}&token={{token}}
VERB:DELETE
BASE URL:{{host}}/v1/token
QUERY STRING:?principal={{principal}}&token={{token}}

Query parameters#

  • principalstring
    Required

    Principal identifier to sign in as (e.g. owner or logical principal id).

    example: root
  • tokenstring
    Required

    The token string returned by `POST /v1/token` to revoke.

    example: 1ZOUMYM1rLWKuWWkcekZwa8TJbaNbLw2

Headers#

Send these headers with the request. Names are case-insensitive per HTTP rules.
  • x-api-keyRequired

    Your BigState API key.

    *provide api key here*
  • Content-TypeRequired

    MIME type of the request body.

    application/json
  • AcceptRequired

    MIME types the client can understand in the response.

    application/json

See authentication headers here.

Response parameters#

  • 204Response body · no content

    The token was revoked. No response body.

  • 401

    Unauthorized.

  • 403

    Access denied. The caller does not have sufficient rights to perform this operation.

  • 404

    No such token for this principal.

  • 400Response body · object

    Bad request.

    {

      "error": 6,

      "desc": "Invalid request"

    }
    • errornumber

      Numeric error code. See the error codes reference for the full list.

    • descstring

      Human-readable description of the error.

Examples#

Revoke token

Delete a session token for the principal. Success: 204, no body.

curl https://api.bigstate.dev/v1/token?principal=root&token=1ZOUMYM1rLWKuWWkcekZwa8TJbaNbLw2 \

  --request DELETE \

  --header 'x-api-key: YOUR_API_KEY' \

  --header 'Content-Type: application/json' \

  --header 'Accept: application/json'
Sign inCreate

© 2024 BigState