Create SAML service provider metadata

GET /_security/saml/metadata/{realm_name}

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.

Response

application/json

metadata string required: An XML string that contains a SAML Service Provider's metadata for the realm.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data

JavaScript Elasticsearch JavaScript Client

const response = await client.security.updateUserProfileData({
  uid: "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
});

Python Elasticsearch Python Client

resp = client.security.update_user_profile_data(
    uid="u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.security().updateUserProfileData(u -> u
    .uid("u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0")
);

C# Elasticsearch .NET Client

var response = await client.Security.UpdateUserProfileDataAsync(uid: "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0");

PHP Elasticsearch PHP Client

$resp = $client->security()->updateUserProfileData([
    "uid" => "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0",
]);

Ruby Elasticsearch Ruby Client

response = client.security.update_user_profile_data(
  uid: "u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0"
)

Response

A successful response from POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data, which indicates that the request is acknowledged.

{
  "acknowledged": true
}