Package co.elastic.clients.elasticsearch.security

Class SamlInvalidateRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.SamlInvalidateRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class SamlInvalidateRequest
extends RequestBase
implements JsonpSerializable
Submits a SAML LogoutRequest message to Elasticsearch for consumption.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static SamlInvalidateRequest of​(java.util.function.Function<SamlInvalidateRequest.Builder,​ObjectBuilder<SamlInvalidateRequest>> fn)

    • acs

      @Nullable public final java.lang.String acs()
      The Assertion Consumer Service URL that matches the one of the SAML realm in Elasticsearch that should be used. You must specify either this parameter or the realm parameter.

      API name: acs

    • queryString

      public final java.lang.String queryString()
      Required - The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include a single parameter named SAMLRequest that contains a SAML logout request that is deflated and Base64 encoded. If the SAML IdP has signed the logout request, the URL should include two extra parameters named SigAlg and Signature that contain the algorithm used for the signature and the signature value itself. In order for Elasticsearch to be able to verify the IdP’s signature, the value of the query_string field must be an exact match to the string provided by the browser. The client application must not attempt to parse or process the string in any way.

      API name: query_string

    • realm

      @Nullable public final java.lang.String realm()
      The name of the SAML realm in Elasticsearch the configuration. You must specify either this parameter or the acs parameter.

      API name: realm

    • 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)

    • setupSamlInvalidateRequestDeserializer

      protected static void setupSamlInvalidateRequestDeserializer​(ObjectDeserializer<SamlInvalidateRequest.Builder> op)