Policy management API - POST bindings of a policy

Latest Dynatrace
Reference
Published Jul 25, 2022

Assigns a policy of the specified level to user groups. Any existing policy bindings remain unaffected.

The request consumes an application/json payload.

POST

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
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
body	AppendLevelPolicyBindingsRequestDto	The JSON body of the request. Contains user groups that must use the policy and optional boundaries.	body	Required

Request body objects

The `AppendLevelPolicyBindingsRequestDto` object

Element	Type	Description	Required
groups	string[]	A list of user groups (specified by IDs) to which the policy applies.	Required
boundaries	string[]	List of boundary UUIDs used in the binding.	Optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "groups": [
    "string"
  ],
  "boundaries": [
    "string"
  ]
}

Response

Response codes

Code	Type	Description
204	-	Success. Policy bindings created.
400	ErrorDto	Failed. The request is invalid
404	ErrorDto	Failed. The specified resource is not found.
422	ErrorDto	The specified response 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 assigns the environment-level policy with the UUID of 0c621587-f978-4c7b-89ee-d2045f611b03 from the mySampleEnv environment to user groups with the following UUIDs:

541802b0-623c-4193-8728-036ed01d4eb4
a468e0e0-ef8f-45d8-9b0f-e016984d838b

The response code of 204 indicates a successful request.

Curl

curl --request POST \
  --url 'https://api.dynatrace.com/iam/v1/repo/environment/lde68092/bindings/0c621587-f978-4c7b-89ee-d2045f611b03' \
  --header 'Authorization: Bearer abcdefjhij1234567890' \
  --header 'Content-Type: application/json' \
  --data '{
  "groups": [
        "541802b0-623c-4193-8728-036ed01d4eb4",
        "a468e0e0-ef8f-45d8-9b0f-e016984d838b"
    ]
}'

Request URL

https://api.dynatrace.com/iam/v1/repo/environment/lde68092/bindings/0c621587-f978-4c7b-89ee-d2045f611b03

Request body

{
  "groups": [
        "541802b0-623c-4193-8728-036ed01d4eb4",
        "a468e0e0-ef8f-45d8-9b0f-e016984d838b"
    ]
}

Response code

204