Package co.elastic.clients.elasticsearch.security

Class SamlCompleteLogoutRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.SamlCompleteLogoutRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SamlCompleteLogoutRequest
extends RequestBase
implements JsonpSerializable

Logout of SAML completely.

Verifies the logout response sent from the SAML IdP.

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.

The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. This API verifies the response by ensuring the content is relevant and validating its signature. An empty response is returned if the verification process is successful. The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. The caller of this API must prepare the request accordingly so that this API can handle either of them.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<SamlCompleteLogoutRequest>	_DESERIALIZER	Json deserializer for SamlCompleteLogoutRequest
static final Endpoint<SamlCompleteLogoutRequest,BooleanResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.saml_complete_logout".

Method Summary

Modifier and Type	Method	Description
final String	content()	If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response.
final List<String>	ids()	Required - A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.
static SamlCompleteLogoutRequest	of(Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)
final String	queryString()	If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI.
final String	realm()	Required - The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response.
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	setupSamlCompleteLogoutRequestDeserializer(ObjectDeserializer<SamlCompleteLogoutRequest.Builder> op)

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

Json deserializer for SamlCompleteLogoutRequest

_ENDPOINT

public static final Endpoint<SamlCompleteLogoutRequest,BooleanResponse,ErrorResponse> _ENDPOINT

Endpoint "security.saml_complete_logout".

Method Details

of

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

content

@Nullable
public final String content()

If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response.

API name: content

ids

public final List<String> ids()

Required - A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user.

API name: ids

queryString

@Nullable
public final String queryString()

If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI.

API name: query_string

realm

public final String realm()

Required - The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response.

API name: realm

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)

setupSamlCompleteLogoutRequestDeserializer

protected static void setupSamlCompleteLogoutRequestDeserializer(ObjectDeserializer<SamlCompleteLogoutRequest.Builder> op)