habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/reference-security-invalidate_token.asciidoc Normal file
View File

@ -0,0 +1,68 @@
[[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
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`
[source,ts]
----
interface SecurityInvalidateTokenRequest extends <<shared-type-request-base, RequestBase>> {
token?: string
refresh_token?: string
realm_name?: <<shared-type-name, Name>>
username?: <<shared-type-username, Username>>
}
----
[discrete]
===== `SecurityInvalidateTokenResponse`
[source,ts]
----
interface SecurityInvalidateTokenResponse {
error_count: <<shared-type-long, long>>
error_details?: <<shared-type-error-cause, ErrorCause>>[]
invalidated_tokens: <<shared-type-long, long>>
previously_invalidated_tokens: <<shared-type-long, long>>
}
----