Package co.elastic.clients.elasticsearch.security

Class SamlServiceProviderMetadataRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.security.SamlServiceProviderMetadataRequest

public class SamlServiceProviderMetadataRequest
extends RequestBase

Create SAML service provider metadata.

Generate SAML metadata for a SAML 2.0 Service Provider.

The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SamlServiceProviderMetadataRequest.Builder	Builder for SamlServiceProviderMetadataRequest.

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 final Endpoint<SamlServiceProviderMetadataRequest,SamlServiceProviderMetadataResponse,ErrorResponse>	_ENDPOINT	Endpoint "security.saml_service_provider_metadata".

Method Summary

Modifier and Type	Method	Description
static SamlServiceProviderMetadataRequest	of(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)
final String	realmName()	Required - The name of the SAML realm in Elasticsearch.

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

_ENDPOINT

public static final Endpoint<SamlServiceProviderMetadataRequest,SamlServiceProviderMetadataResponse,ErrorResponse> _ENDPOINT

Endpoint "security.saml_service_provider_metadata".

Method Details

of

public static SamlServiceProviderMetadataRequest of(Function<SamlServiceProviderMetadataRequest.Builder,ObjectBuilder<SamlServiceProviderMetadataRequest>> fn)

realmName

public final String realmName()

Required - The name of the SAML realm in Elasticsearch.

API name: realm_name