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
Creates a SAML authentication request (<AuthnRequest>) as a URL string,
based on the configuration of the respective SAML realm in Elasticsearch.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<SamlPrepareAuthenticationRequest>
Json deserializer forSamlPrepareAuthenticationRequest
static final Endpoint<SamlPrepareAuthenticationRequest,
SamlPrepareAuthenticationResponse, ErrorResponse> Endpoint "security.saml_prepare_authentication
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
acs()
The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.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
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
-
Field Details
-
_DESERIALIZER
Json deserializer forSamlPrepareAuthenticationRequest
-
_ENDPOINT
public static final Endpoint<SamlPrepareAuthenticationRequest,SamlPrepareAuthenticationResponse, _ENDPOINTErrorResponse> Endpoint "security.saml_prepare_authentication
".
-
-
Method Details
-
of
-
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
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
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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSamlPrepareAuthenticationRequestDeserializer
protected static void setupSamlPrepareAuthenticationRequestDeserializer(ObjectDeserializer<SamlPrepareAuthenticationRequest.Builder> op)
-