Package co.elastic.clients.elasticsearch.security

Class SamlPrepareAuthenticationRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.SamlPrepareAuthenticationRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SamlPrepareAuthenticationRequest
extends RequestBase
implements JsonpSerializable

Prepare SAML authentication.

Create a SAML authentication request (<AuthnRequest>) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.

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 returns a URL pointing to the SAML Identity Provider. You can use the URL to redirect the browser of the user in order to continue the authentication process. The URL includes a single parameter named SAMLRequest, which contains a SAML Authentication request that is deflated and Base64 encoded. If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named SigAlg and Signature. These parameters contain the algorithm used for the signature and the signature value itself. It also returns a random string that uniquely identifies this SAML Authentication request. The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<SamlPrepareAuthenticationRequest>	_DESERIALIZER	Json deserializer for SamlPrepareAuthenticationRequest
static final Endpoint<SamlPrepareAuthenticationRequest,SamlPrepareAuthenticationResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.saml_prepare_authentication".

Method Summary

Modifier and Type	Method	Description
final String	acs()	The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.
static SamlPrepareAuthenticationRequest	of(Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn)
final String	realm()	The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.
final String	relayState()	A string that will be included in the redirect URL that this API returns as the RelayState query parameter.
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	setupSamlPrepareAuthenticationRequestDeserializer(ObjectDeserializer<SamlPrepareAuthenticationRequest.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<SamlPrepareAuthenticationRequest> _DESERIALIZER

Json deserializer for SamlPrepareAuthenticationRequest

_ENDPOINT

public static final Endpoint<SamlPrepareAuthenticationRequest,SamlPrepareAuthenticationResponse,ErrorResponse> _ENDPOINT

Endpoint "security.saml_prepare_authentication".

Method Details

of

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

acs

@Nullable
public final String acs()

The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication request. You must specify either this parameter or the realm parameter.

API name: acs

realm

@Nullable
public final String realm()

The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request. You must specify either this parameter or the acs parameter.

API name: realm

relayState

@Nullable
public final String relayState()

A string that will be included in the redirect URL that this API returns as the RelayState query parameter. If the Authentication Request is signed, this value is used as part of the signature computation.

API name: relay_state

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)

setupSamlPrepareAuthenticationRequestDeserializer

protected static void setupSamlPrepareAuthenticationRequestDeserializer(ObjectDeserializer<SamlPrepareAuthenticationRequest.Builder> op)