Method: Elasticsearch::XPack::API::Security::Actions#invalidate_token

Defined in:
lib/elasticsearch/xpack/api/actions/security/invalidate_token.rb

#invalidate_token(arguments = {}) ⇒ Object

Invalidates one or more access tokens or refresh tokens.

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The token to invalidate (Required)

Raises:

  • (ArgumentError)

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/elasticsearch/xpack/api/actions/security/invalidate_token.rb', line 30

def invalidate_token(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

  headers = arguments.delete(:headers) || {}

  arguments = arguments.clone

  method = Elasticsearch::API::HTTP_DELETE
  path   = "_security/oauth2/token"
  params = {}

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end