Package co.elastic.clients.elasticsearch.security

Class OidcLogoutRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.OidcLogoutRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class OidcLogoutRequest
extends RequestBase
implements JsonpSerializable

Logout of OpenID Connect.

Invalidate an access token and a refresh token that were generated as a response to the /_security/oidc/authenticate API.

If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.

Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<OidcLogoutRequest>	_DESERIALIZER	Json deserializer for OidcLogoutRequest
static final Endpoint<OidcLogoutRequest,OidcLogoutResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.oidc_logout".

Method Summary

Modifier and Type	Method	Description
static OidcLogoutRequest	of(Function<OidcLogoutRequest.Builder,ObjectBuilder<OidcLogoutRequest>> fn)
final String	refreshToken()	The refresh token to be invalidated.
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	setupOidcLogoutRequestDeserializer(ObjectDeserializer<OidcLogoutRequest.Builder> op)
final String	token()	Required - The access token to be invalidated.

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<OidcLogoutRequest> _DESERIALIZER

Json deserializer for OidcLogoutRequest

_ENDPOINT

public static final Endpoint<OidcLogoutRequest,OidcLogoutResponse,ErrorResponse> _ENDPOINT

Endpoint "security.oidc_logout".

Method Details

of

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

refreshToken

@Nullable
public final String refreshToken()

The refresh token to be invalidated.

API name: refresh_token

token

public final String token()

Required - The access token to be invalidated.

API name: token

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)

setupOidcLogoutRequestDeserializer

protected static void setupOidcLogoutRequestDeserializer(ObjectDeserializer<OidcLogoutRequest.Builder> op)