Package co.elastic.clients.elasticsearch.security

Class InvalidateTokenRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.InvalidateTokenRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class InvalidateTokenRequest
extends RequestBase
implements JsonpSerializable

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.

NOTE: While all parameters are optional, at least one of them is required. More specifically, either one of token or refresh_token parameters is required. If none of these two are specified, then realm_name and/or username need to be specified.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvalidateTokenRequest.Builder	Builder for InvalidateTokenRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<InvalidateTokenRequest>	_DESERIALIZER	Json deserializer for InvalidateTokenRequest
static final Endpoint<InvalidateTokenRequest,InvalidateTokenResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.invalidate_token".

Method Summary

Modifier and Type	Method	Description
static InvalidateTokenRequest	of(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)
final String	realmName()	The name of an authentication realm.
final String	refreshToken()	A refresh token.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupInvalidateTokenRequestDeserializer(ObjectDeserializer<InvalidateTokenRequest.Builder> op)
final String	token()	An access token.
final String	username()	The username of a user.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<InvalidateTokenRequest> _DESERIALIZER

Json deserializer for InvalidateTokenRequest

_ENDPOINT

public static final Endpoint<InvalidateTokenRequest,InvalidateTokenResponse,ErrorResponse> _ENDPOINT

Endpoint "security.invalidate_token".

Method Details

of

public static InvalidateTokenRequest of(Function<InvalidateTokenRequest.Builder,ObjectBuilder<InvalidateTokenRequest>> fn)

realmName

@Nullable
public final String realmName()

The name of an authentication realm. This parameter cannot be used with either refresh_token or token.

API name: realm_name

refreshToken

@Nullable
public final String refreshToken()

A refresh token. This parameter cannot be used if any of refresh_token, realm_name, or username are used.

API name: refresh_token

token

@Nullable
public final String token()

An access token. This parameter cannot be used if any of refresh_token, realm_name, or username are used.

API name: token

username

@Nullable
public final String username()

The username of a user. This parameter cannot be used with either refresh_token or token.

API name: username

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupInvalidateTokenRequestDeserializer

protected static void setupInvalidateTokenRequestDeserializer(ObjectDeserializer<InvalidateTokenRequest.Builder> op)