IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete SAML configuration Update SAML configuration »

› › › ›

Get SAML configuration

edit

Get SAML configuration

edit

Retrieves a single SAML security realm configuration.

Request

edit

GET /api/v1/platform/configuration/security/realms/saml/{realm_id}

Path parameters

edit

Name	Type	Required	Description
`realm_id`	`string`	Y	The Elasticsearch Security realm identifier.

Responses

edit

200

(SamlSettings)

The SAML configuration was successfully retrieved

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

404

(BasicFailedReply)

The realm specified by {realm_id} cannot be found. (code: security_realm.not_found)

Headers

x-cloud-error-codes (string; allowed values: [security_realm.not_found]): The error codes associated with the response

Request example

edit

curl -XGET https://{{hostname}}/api/v1/platform/configuration/security/realms/saml/{realm_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Delete SAML configuration Update SAML configuration »