Package co.elastic.clients.elasticsearch.security

Class SamlLogoutRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.SamlLogoutRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SamlLogoutRequest
extends RequestBase
implements JsonpSerializable

Logout of SAML.

Submits a request to invalidate an access token and refresh token.

NOTE: This API is intended for use by custom web applications other than Kibana. If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.

This API invalidates the tokens that were generated for a user by the SAML authenticate API. If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<SamlLogoutRequest>	_DESERIALIZER	Json deserializer for SamlLogoutRequest
static final Endpoint<SamlLogoutRequest,SamlLogoutResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.saml_logout".

Method Summary

Modifier and Type	Method	Description
static SamlLogoutRequest	of(Function<SamlLogoutRequest.Builder,ObjectBuilder<SamlLogoutRequest>> fn)
final String	refreshToken()	The refresh token that was returned as a response to calling the SAML authenticate API.
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	setupSamlLogoutRequestDeserializer(ObjectDeserializer<SamlLogoutRequest.Builder> op)
final String	token()	Required - The access token that was returned as a response to calling the SAML authenticate API.

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

Json deserializer for SamlLogoutRequest

_ENDPOINT

public static final Endpoint<SamlLogoutRequest,SamlLogoutResponse,ErrorResponse> _ENDPOINT

Endpoint "security.saml_logout".

Method Details

of

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

refreshToken

@Nullable
public final String refreshToken()

The refresh token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent refresh token that was received after refreshing the original access token.

API name: refresh_token

token

public final String token()

Required - The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received after refreshing the original one by using a refresh_token.

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)

setupSamlLogoutRequestDeserializer

protected static void setupSamlLogoutRequestDeserializer(ObjectDeserializer<SamlLogoutRequest.Builder> op)