It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Create SAML configuration
editCreate SAML configuration
editCreates a new SAML configuration.
Request
editPOST /api/v1/platform/configuration/security/realms/saml
Request body
edit(SamlSettings
) (required) The SAML configuration
Responses
edit-
201
-
(
EmptyResponse
) The SAML configuration was successfully createdHeaders
-
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
-
-
400
-
(
BasicFailedReply
) * The realm id is already in use. (code:security_realm.id_conflict
) * The selected id is not valid. (code:security_realm.invalid_id
) * Order must be greater than zero. (code:security_realm.invalid_order
) * Invalid Elasticsearch Security realm type. (code:security_realm.invalid_type
) * The realm order is already in use. (code:security_realm.order_conflict
) * Advanced YAML format is invalid. (code:security_realm.invalid_yaml
) * The SAML IDP metadata endpoint returned an error response code 200 OK. (code:security_realm.saml.invalid_idp_metadata_url
) * Invalid certificate bundle URL. (code:security_realm.invalid_bundle_url
)Headers
-
x-cloud-error-codes
(string
; allowed values: [security_realm.id_conflict
,security_realm.invalid_id
,security_realm.invalid_order
,security_realm.invalid_type
,security_realm.order_conflict
,security_realm.invalid_yaml
,security_realm.saml.invalid_idp_metadata_url
,security_realm.invalid_bundle_url
]) - The error codes associated with the response
-
-
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/platform/configuration/security/realms/saml \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "attributes" : { "dn" : "string", "groups" : "string", "mail" : "string", "name" : "string", "principal" : "string" }, "enabled" : true, "encryption_certificate_url" : "string", "encryption_certificate_url_password" : "string", "force_authn" : true, "id" : "string", "idp" : { "entity_id" : "string", "metadata_path" : "string", "use_single_logout" : true }, "name" : "string", "order" : 0, "override_yaml" : "string", "role_mappings" : { "default_roles" : [ "string" ], "rules" : [ { "roles" : [ "string" ], "type" : "string", "value" : "string" } ] }, "signing_certificate_url" : "string", "signing_certificate_url_password" : "string", "signing_saml_messages" : [ "string" ], "sp" : { "acs" : "string", "entity_id" : "string", "logout" : "string" }, "ssl_certificate_url" : "string", "ssl_certificate_url_truststore_password" : "string", "ssl_certificate_url_truststore_type" : "string" } '