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 Get SAML configuration »

› › › ›

Delete SAML configuration

edit

Delete SAML configuration

edit

Deletes a single SAML configuration. NOTE: This is a beta feature.

Request

edit

DELETE /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.

Query parameters

edit

Name	Type	Required	Description
`version`	`integer`	N	When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)

Responses

edit

200: (EmptyResponse) The SAML configuration was successfully deleted
404: (BasicFailedReply) The realm specified by {realm_id} cannot be found. (code: security_realm.not_found)
409: (BasicFailedReply) There is a version conflict. (code: security_realm.version_conflict)
449: (BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XDELETE {{hostname}}/api/v1/platform/configuration/security/realms/saml/{realm_id} \
-u $CLOUD_USER:$CLOUD_KEY

« Create SAML configuration Get SAML configuration »