Enables the security deployment

edit

Enables the existing security deployment configuration. NOTE: This is a beta feature.

Request

edit

POST /api/v1/platform/configuration/security/deployment/_enable

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 security deployment was successfully enabled

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_deployment.not_found)

409

(BasicFailedReply) There is a version conflict. (code: security_deployment.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 -XPOST {{hostname}}/api/v1/platform/configuration/security/deployment/_enable \
-u $CLOUD_USER:$CLOUD_KEY