2018-11-05 23:26:12 -05:00
|
|
|
--
|
|
|
|
|
:api: invalidate-token
|
|
|
|
|
:request: InvalidateTokenRequest
|
|
|
|
|
:response: InvalidateTokenResponse
|
|
|
|
|
--
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}"]
|
|
|
|
|
=== Invalidate Token API
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
|
|
|
|
==== Invalidate Token Request
|
2018-12-18 09:12:43 -05:00
|
|
|
The +{request}+ supports invalidating
|
2018-11-05 23:26:12 -05:00
|
|
|
|
2018-12-18 09:12:43 -05:00
|
|
|
. A specific token, that can be either an _access token_ or a _refresh token_
|
|
|
|
|
|
|
|
|
|
. All tokens (both _access tokens_ and _refresh tokens_) for a specific realm
|
|
|
|
|
|
|
|
|
|
. All tokens (both _access tokens_ and _refresh tokens_) for a specific user
|
|
|
|
|
|
|
|
|
|
. All tokens (both _access tokens_ and _refresh tokens_) for a specific user in a specific realm
|
|
|
|
|
|
|
|
|
|
===== Specific access token
|
2018-11-05 23:26:12 -05:00
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[invalidate-access-token-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
2018-12-18 09:12:43 -05:00
|
|
|
===== Specific refresh token
|
2018-11-05 23:26:12 -05:00
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[invalidate-refresh-token-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
2018-12-18 09:12:43 -05:00
|
|
|
===== All tokens for realm
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[invalidate-realm-tokens-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
|
|
|
|
===== All tokens for user
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[invalidate-user-tokens-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
|
|
|
|
===== All tokens for user in realm
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[invalidate-user-realm-tokens-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
|
2018-11-05 23:26:12 -05:00
|
|
|
include::../execution.asciidoc[]
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
|
|
|
|
==== Invalidate Token Response
|
|
|
|
|
|
2018-12-18 09:12:43 -05:00
|
|
|
The returned +{response}+ contains the information regarding the tokens that the request
|
|
|
|
|
invalidated.
|
|
|
|
|
|
|
|
|
|
`invalidatedTokens`:: Available using `getInvalidatedTokens` denotes the number of tokens
|
|
|
|
|
that this request invalidated.
|
|
|
|
|
|
|
|
|
|
`previouslyInvalidatedTokens`:: Available using `getPreviouslyInvalidatedTokens` denotes
|
|
|
|
|
the number of tokens that this request attempted to invalidate
|
|
|
|
|
but were already invalid.
|
2018-11-05 23:26:12 -05:00
|
|
|
|
2018-12-18 09:12:43 -05:00
|
|
|
`errors`:: Available using `getErrors` contains possible errors that were encountered while
|
|
|
|
|
attempting to invalidate specific tokens.
|
2018-11-05 23:26:12 -05:00
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
2018-12-18 03:05:50 -05:00
|
|
|
--------------------------------------------------
|
