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
Submits a SAML Response message to Elasticsearch for consumption.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SamlAuthenticateRequest.Builder
Builder forSamlAuthenticateRequest
.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<SamlAuthenticateRequest>
_DESERIALIZER
Json deserializer forSamlAuthenticateRequest
static Endpoint<SamlAuthenticateRequest,SamlAuthenticateResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.saml_authenticate
". -
Method Summary
Modifier and Type Method Description java.lang.String
content()
Required - The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document.java.util.List<java.lang.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(java.util.function.Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn)
java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forSamlAuthenticateRequest
-
_ENDPOINT
public static final Endpoint<SamlAuthenticateRequest,SamlAuthenticateResponse,ErrorResponse> _ENDPOINTEndpoint "security.saml_authenticate
".
-
-
Method Details
-
of
public static SamlAuthenticateRequest of(java.util.function.Function<SamlAuthenticateRequest.Builder,ObjectBuilder<SamlAuthenticateRequest>> fn) -
content
public final java.lang.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 java.util.List<java.lang.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 java.lang.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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSamlAuthenticateRequestDeserializer
protected static void setupSamlAuthenticateRequestDeserializer(ObjectDeserializer<SamlAuthenticateRequest.Builder> op)
-