Invalidate a token | Elasticsearch API (v8)

Invalidate a token Added in 5.5.0

DELETE /_security/oauth2/token

The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the xpack.security.authc.token.timeout setting.

The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.

application/json

Body Required

token string
refresh_token string
realm_name string
username string

Responses

200 application/json
Hide response attributes Show response attributes object
- error_count number Required
- error_details array[object]
  
  Hide error_details attributes Show error_details attributes object
  
  type string Required
  
  The type of error
  
  reason string
  
  A human-readable explanation of the error, in english
  
  stack_trace string
  
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  
  caused_by object
  
  Additional properties are allowed.
  
  root_cause array[object]
  
  Additional properties are allowed.
  
  suppressed array[object]
  
  Additional properties are allowed.
- invalidated_tokens number Required
- previously_invalidated_tokens number Required

DELETE /_security/oauth2/token

curl \
 -X DELETE http://api.example.com/_security/oauth2/token \
 -H "Content-Type: application/json" \
 -d '{"token":"string","refresh_token":"string","realm_name":"string","username":"string"}'

Request examples

{
  "token": "string",
  "refresh_token": "string",
  "realm_name": "string",
  "username": "string"
}

Response examples (200)

{
  "error_count": 42.0,
  "error_details": [
    {
      "type": "string",
      "reason": "string",
      "stack_trace": "string",
      "caused_by": {},
      "root_cause": [
        {}
      ],
      "suppressed": [
        {}
      ]
    }
  ],
  "invalidated_tokens": 42.0,
  "previously_invalidated_tokens": 42.0
}