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:
-
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<SamlAuthenticateRequest>
Json deserializer forSamlAuthenticateRequest
static final Endpoint<SamlAuthenticateRequest,
SamlAuthenticateResponse, ErrorResponse> Endpoint "security.saml_authenticate
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
content()
Required - The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document.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
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
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forSamlAuthenticateRequest
-
_ENDPOINT
public static final Endpoint<SamlAuthenticateRequest,SamlAuthenticateResponse, _ENDPOINTErrorResponse> Endpoint "security.saml_authenticate
".
-
-
Method Details
-
of
public static SamlAuthenticateRequest of(Function<SamlAuthenticateRequest.Builder, ObjectBuilder<SamlAuthenticateRequest>> fn) -
content
Required - The SAML response as it was sent by the user’s browser, usually a Base64 encoded XML document.API name:
content
-
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
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)
-