Package co.elastic.clients.elasticsearch.security

Class SamlAuthenticateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.SamlAuthenticateRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SamlAuthenticateRequest
extends RequestBase
implements JsonpSerializable

Authenticate SAML.

Submit a SAML response message to Elasticsearch for consumption.

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 message that is submitted can be:

• A response to a SAML authentication request that was previously created using the SAML prepare authentication API.
• An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.

In either case, the SAML message needs to be a base64 encoded XML document with a root element of <Response>.

After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<SamlAuthenticateRequest>	_DESERIALIZER	Json deserializer for SamlAuthenticateRequest
static final Endpoint<SamlAuthenticateRequest,SamlAuthenticateResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.saml_authenticate".

Method Summary

Modifier and Type	Method	Description
final String	content()	Required - The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document.
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 SamlAuthenticateRequest	of(Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)
final String	realm()	The name of the realm that should authenticate the SAML 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	setupSamlAuthenticateRequestDeserializer(ObjectDeserializer<SamlAuthenticateRequest.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<SamlAuthenticateRequest> _DESERIALIZER

Json deserializer for SamlAuthenticateRequest

_ENDPOINT

public static final Endpoint<SamlAuthenticateRequest,SamlAuthenticateResponse,ErrorResponse> _ENDPOINT

Endpoint "security.saml_authenticate".

Method Details

of

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

content

public final String content()

Required - The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document.

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

realm

@Nullable
public final String realm()

The name of the realm that should authenticate the SAML response. Useful in cases where many SAML realms are defined.

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)

setupSamlAuthenticateRequestDeserializer

protected static void setupSamlAuthenticateRequestDeserializer(ObjectDeserializer<SamlAuthenticateRequest.Builder> op)