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 Active Directory configurationedit
Creates a new Active Directory configuration.
Requestedit
POST /api/v1/platform/configuration/security/realms/active-directory
Request bodyedit
(ActiveDirectorySettings
) (required) The Active Directory configuration
Responsesedit
-
201
-
(
EmptyResponse
) The Active Directory 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 url format is invalid. (code:security_realm.invalid_url
) * Invalid Active Directory URL. (code:security_realm.active_directory.invalid_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.invalid_url
,security_realm.active_directory.invalid_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 exampleedit
curl -XPOST https://{{hostname}}/api/v1/platform/configuration/security/realms/active-directory \ -H "Authorization: ApiKey $ECE_API_KEY" \ -d ' { "bind_anonymously" : true, "bind_dn" : "string", "bind_password" : "string", "certificate_url" : "string", "certificate_url_truststore_password" : "string", "certificate_url_truststore_type" : "string", "domain_name" : "string", "enabled" : true, "group_search" : { "base_dn" : "string", "scope" : "string" }, "id" : "string", "load_balance" : { "cache_ttl" : "string", "type" : "string" }, "name" : "string", "order" : 0, "override_yaml" : "string", "role_mappings" : { "default_roles" : [ "string" ], "rules" : [ { "roles" : [ "string" ], "type" : "string", "value" : "string" } ] }, "urls" : [ "string" ], "user_search" : { "base_dn" : "string", "filter" : "string", "scope" : "string" } } '