Policy management API - GET bindings of a policy

Lists all user groups that use a policy.

The request produces an application/json payload.

GET

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

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
policyUuidstring

The ID of the required policy.

pathrequired

Response

Response codes

CodeTypeDescription
200LevelPolicyBindingDto

Successful response - list of policy bindings with parameters

404ErrorDto

Failed. The specified resource is not found.

Response body objects

The LevelPolicyBindingDto object

ElementTypeDescription
levelTypestring

The type of the policy level.

levelIdstring

The ID of the policy level.

policyBindingsBinding[]-

The Binding object

ElementTypeDescription
policyUuidstring

The ID of the policy.

groupsstring[]

A list of user groups to which the policy applies.

parametersobject

Parameters from bound policies

metadataobject

Metadata from bound policies

Response body JSON model

{
  "levelType": "string",
  "levelId": "string",
  "policyBindings": [
    {
      "policyUuid": "string",
      "groups": [
        "string"
      ],
      "parameters": {},
      "metadata": {}
    }
  ]
}

Example

In this example, the request lists user groups that are using the policy with the UUID of 0c621587-f978-4c7b-89ee-d2045f611b03 from the mySampleEnv environment.

Curl

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

Request URL

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

Response body

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

Response code

200