Policy management API - DELETE bindings of a policy

Latest Dynatrace
Reference
Published Jul 25, 2022

Removes a policy from all user groups on the specified level. After a successful request, no user group is using the policy anymore.

DELETE

https://api.dynatrace.com/iam/v1/repo/{levelType}/{levelId}/bindings/{policyUuid}

Authentication

To execute this request, you need the Allow IAM policy configuration for environments (iam-policies-management) permission assigned to your token. To learn how to obtain and use it, see OAuth clients.

Parameters

Parameter	Type	Description	In	Required
forceMultiple	-	Forces multiple in case delete by parameters and metadata query	query	Required
query-params	object	Key-value pairs for policy template parameters and metadata. Only bindings matching given parameters and metadata will be updated or deleted.	query	Optional
policyUuid	-	The ID of the required policy.	path	Required
levelId	-	The ID of the policy level. Use one of the following values, depending on the level type: account: use the UUID of the account. environment: use the ID of the environment.	path	Required
levelType	-	The type of the policy level. The following values are available: `account`: An account policy applies to all environments of an account. `environment`: An environment policy applies to a specific environment. Each level inherits the policies of the higher level and extends them with its own policies.	path	Required

Response

Response codes

Code	Type	Description
204	-	Success. Policy binding has been deleted. The response doesn't have a body.
400	ErrorDto	Failed. The request is invalid
404	ErrorDto	Failed. The specified resource is not found.

Response body objects

The `ErrorDto` object

Element	Type	Description
code	number	The code of the error.
message	string	A short description of the error.
errorsMap	object	-

Response body JSON models

{
  "code": 1,
  "message": "string",
  "errorsMap": {}
}

Example

In this example, the request removes the environment-level (mySampleEnv environment) policy with the UUID of 0c621587-f978-4c7b-89ee-d2045f611b03 from all user groups that are using it. The response code of 204 indicates a successful request.

Curl

curl --request DELETE \
  --url 'https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/bindings/0c621587-f978-4c7b-89ee-d2045f611b03?forceMultiple=false' \
  --header 'Authorization: Bearer abcdefjhij1234567890'

Request URL

https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/bindings/0c621587-f978-4c7b-89ee-d2045f611b03?forceMultiple=false

Response code

204