Package co.elastic.clients.elasticsearch.security

Class SamlInvalidateRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<SamlInvalidateRequest.Builder>
co.elastic.clients.elasticsearch.security.SamlInvalidateRequest.Builder
All Implemented Interfaces:
WithJson<SamlInvalidateRequest.Builder>, ObjectBuilder<SamlInvalidateRequest>
Enclosing class:
SamlInvalidateRequest
public static class SamlInvalidateRequest.Builder
extends RequestBase.AbstractBuilder<SamlInvalidateRequest.Builder>
implements ObjectBuilder<SamlInvalidateRequest>
Builder for SamlInvalidateRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • acs

      public final SamlInvalidateRequest.Builder acs​(@Nullable java.lang.String value)
      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 SamlInvalidateRequest.Builder queryString​(java.lang.String value)
      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

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

      API name: realm

    • self

      protected SamlInvalidateRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<SamlInvalidateRequest.Builder>

    • build

      public SamlInvalidateRequest build()
      Builds a SamlInvalidateRequest.
      Specified by:
      build in interface ObjectBuilder<SamlInvalidateRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.