[[reference-security-invalidate_token]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
[[client.security.invalidateToken]]
=== client.security.invalidateToken

Invalidate a 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.

{ref}/security-api-invalidate-token.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(SecurityInvalidateTokenRequest, options?): Promise<SecurityInvalidateTokenResponse>
----

[discrete]
==== SecurityInvalidateTokenRequest

[pass]
++++
<pre>
++++
interface SecurityInvalidateTokenRequest extends <<RequestBase>> {
  token?: string
  refresh_token?: string
  realm_name?: <<Name>>
  username?: <<Username>>
}

[pass]
++++
</pre>
++++
[discrete]
==== SecurityInvalidateTokenResponse

[pass]
++++
<pre>
++++
interface SecurityInvalidateTokenResponse {
  error_count: <<_long, long>>
  error_details?: <<ErrorCause>>[]
  invalidated_tokens: <<_long, long>>
  previously_invalidated_tokens: <<_long, long>>
}

[pass]
++++
</pre>
++++
