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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SamlPrepareAuthenticationRequest.Builder
Builder forSamlPrepareAuthenticationRequest
.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 JsonpDeserializer<SamlPrepareAuthenticationRequest>
_DESERIALIZER
Json deserializer forSamlPrepareAuthenticationRequest
static Endpoint<SamlPrepareAuthenticationRequest,SamlPrepareAuthenticationResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.saml_prepare_authentication
". -
Method Summary
Modifier and Type Method Description java.lang.String
acs()
The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch.static SamlPrepareAuthenticationRequest
of(java.util.function.Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn)
java.lang.String
realm()
The name of the SAML realm in Elasticsearch for which the configuration is used to generate the authentication request.java.lang.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
Json deserializer forSamlPrepareAuthenticationRequest
-
_ENDPOINT
public static final Endpoint<SamlPrepareAuthenticationRequest,SamlPrepareAuthenticationResponse,ErrorResponse> _ENDPOINTEndpoint "security.saml_prepare_authentication
".
-
-
Method Details
-
of
public static SamlPrepareAuthenticationRequest of(java.util.function.Function<SamlPrepareAuthenticationRequest.Builder,ObjectBuilder<SamlPrepareAuthenticationRequest>> fn) -
acs
@Nullable public final java.lang.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 java.lang.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 java.lang.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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSamlPrepareAuthenticationRequestDeserializer
protected static void setupSamlPrepareAuthenticationRequestDeserializer(ObjectDeserializer<SamlPrepareAuthenticationRequest.Builder> op)
-