Class SamlCompleteLogoutRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.security.SamlCompleteLogoutRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class SamlCompleteLogoutRequest extends RequestBase implements JsonpSerializable
Verifies the logout response sent from the SAML IdP.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SamlCompleteLogoutRequest.Builder
Builder forSamlCompleteLogoutRequest
.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<SamlCompleteLogoutRequest>
_DESERIALIZER
Json deserializer forSamlCompleteLogoutRequest
static Endpoint<SamlCompleteLogoutRequest,BooleanResponse,ErrorResponse>
_ENDPOINT
Endpoint "security.saml_complete_logout
". -
Method Summary
Modifier and Type Method Description java.lang.String
content()
If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response.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 SamlCompleteLogoutRequest
of(java.util.function.Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn)
java.lang.String
queryString()
If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI.java.lang.String
realm()
Required - The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout 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
setupSamlCompleteLogoutRequestDeserializer(ObjectDeserializer<SamlCompleteLogoutRequest.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 forSamlCompleteLogoutRequest
-
_ENDPOINT
Endpoint "security.saml_complete_logout
".
-
-
Method Details
-
of
public static SamlCompleteLogoutRequest of(java.util.function.Function<SamlCompleteLogoutRequest.Builder,ObjectBuilder<SamlCompleteLogoutRequest>> fn) -
content
@Nullable public final java.lang.String content()If the SAML IdP sends the logout response with the HTTP-Post binding, this field must be set to the value of the SAMLResponse form parameter from the logout response.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
-
queryString
@Nullable public final java.lang.String queryString()If the SAML IdP sends the logout response with the HTTP-Redirect binding, this field must be set to the query string of the redirect URI.API name:
query_string
-
realm
public final java.lang.String realm()Required - The name of the SAML realm in Elasticsearch for which the configuration is used to verify the logout response.API name:
realm
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSamlCompleteLogoutRequestDeserializer
protected static void setupSamlCompleteLogoutRequestDeserializer(ObjectDeserializer<SamlCompleteLogoutRequest.Builder> op)
-