• Home
  • API
  • Account management
  • Policy management
  • Bindings
  • PUT policy level binding

Policy management API - PUT bindings of a policy level

Updates the list of user groups that are using policies of a policy level. The request overwrites any existing bindings.

The request consumes and produces an application/json payload.

PUT

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

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 Authentication.

Parameters

ParameterTypeDescriptionInRequired
levelTypestring

The type of the policy level. The following values are available:

  • global: A global policy applies to all accounts and environments. It is defined and managed by Dynatrace.
  • 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.

pathrequired
levelIdstring

The ID of the policy level. Use one of the following values, depending on the level type:

  • global: use the global value.
  • account: use the UUID of the account.
  • environment: use the ID of the environment.
pathrequired
bodyCreateLevelPolicyBindingsRequestDto

The JSON body of the request. Contains new policy bindings of a level.

Any existing binding not presented in the request is discarded.

bodyrequired

Request body objects

The CreateLevelPolicyBindingsRequestDto object

ElementTypeDescriptionRequired
policyBindingsBinding[]

A list of policy bindings of the user group.

required

The Binding object

ElementTypeDescriptionRequired
policyUuidstring

The ID of the policy.

required
groupsstring[]

A list of user groups to which the policy applies.

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.

json
{
  "policyBindings": [
    {
      "policyUuid": "string",
      "groups": [
        "string"
      ]
    }
  ]
}

Response

Response codes

CodeTypeDescription
204

Success. The binding policies have been updated. The response doesn't have a body.

400ErrorDto

Failed. The request is invalid

404ErrorDto

Failed. The specified resource is not found.

422ErrorDto

The specified response not found

Example

In this example, the request overwrites the list of environment-level policies for the mySampleEnv environment. The policy with the UUID of 0c621587-f978-4c7b-89ee-d2045f611b03 is assigned 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

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

Request URL

plaintext
https://api.dynatrace.com/iam/v1/repo/environment/mySampleEnv/bindings

Request body

json
{
  "policyBindings": [
    {
      "policyUuid": "0c621587-f978-4c7b-89ee-d2045f611b03",
      "groups": [
        "a468e0e0-ef8f-45d8-9b0f-e016984d838b",
        "541802b0-623c-4193-8728-036ed01d4eb4"
      ]
    }
  ]
}

Response code

204