Policy management API - PUT bindings of a user group

Latest Dynatrace
Reference
Published Jul 25, 2022

Updates a list of policies assigned to a user group. The request overwrites an existing set of policies.

The request consumes an application/json payload.

PUT

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

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
groupUuid	-	The ID of the required user group.	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	PolicyUuidsDto	The JSON body of the request. Contains new policies for the group. Any policy not presented in the request is discarded.	body	Required

Request body objects

The `PolicyUuidsDto` object

Element	Type	Description	Required
policyUuids	string[]	A list of policies bound to the user group.	Required

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.

{
  "policyUuids": [
    "string"
  ]
}

Response

Response codes

Code	Type	Description
204	-	Success. The group policies have been updated. The response doesn't have a body.
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 policy with the UUID of 74e51763-1118-4833-8b1e-6b5f0082052a to the user group with the UUID of 541802b0-623c-4193-8728-036ed01d4eb4 from the mySampleEnv environment. The response code of 204 indicates a successful request.

Curl

curl --request PUT \
  --url 'https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/bindings/groups/541802b0-623c-4193-8728-036ed01d4eb4' \
  --header 'Authorization: Bearer abcdefjhij1234567890' \
  --header 'Content-Type: application/json' \
  --data '{
  "policyUuids": [
    "74e51763-1118-4833-8b1e-6b5f0082052a"
  ]
}'

Request URL

https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/bindings/groups/541802b0-623c-4193-8728-036ed01d4eb4

Request body

{
  "policyUuids": [
    "74e51763-1118-4833-8b1e-6b5f0082052a"
  ]
}

Response code

204