Create SAML service provider metadata Added in 7.11.0

GET /_security/saml/metadata/{realm_name}
Api key auth Basic auth Bearer auth

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.

Path parameters

  • realm_name string Required

    The name of the SAML realm in Elasticsearch.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • metadata string Required

      An XML string that contains a SAML Service Provider's metadata for the realm.
GET /_security/saml/metadata/{realm_name} 
curl \
 --request GET 'http://api.example.com/_security/saml/metadata/{realm_name}' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. 
{
  "acknowledged": true
}