Permission management API - GET permissions

Lists all permissions assigned to a user group from your Dynatrace account.

The request produces an application/json payload.

GET	`https://api.dynatrace.com/iam/v1/accounts/{accountUuid}/groups/{groupUuid}/permissions`

Authentication

To execute this request, you need the Allow read access for identity resources (users and groups) (account-idm-read) scope assigned to your token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter	Type	Description	In	Required
accountUuid	string	The ID of the required account. You can find the UUID on the Account > Account management API page, during creation of an OAuth client.	path	required
groupUuid	string	The UUID of the required user group.	path	required

Parameter

Type

Description

Required

accountUuid

string

The ID of the required account.

You can find the UUID on the Account > Account management API page, during creation of an OAuth client.

path

required

groupUuid

string

The UUID of the required user group.

path

required

Response

Response codes

Code	Type	Description
200	PermissionsGroupDto	Success. The response contains permissions of the user group.

Response body objects

The `PermissionsGroupDto` object

Element	Type	Description
uuid	string	The UUID of the user group.
name	string	The name of the user group.
description	string	A short description of the user group.
federatedAttributeValues	string[]	A list of values associating this group with the corresponding claim from an identity provider.
owner	string	The identity provider from which the group originates. `LOCAL` `SCIM` `SAML` `DCS`
createdAt	string	The date and time of the group creation in `2021-05-01T15:11:00Z` format.
updatedAt	string	The date and time of the most recent group modification in `2021-05-01T15:11:00Z` format.
permissions	PermissionsDto[]	A list of permissions assigned to the group.

The `PermissionsDto` object

Element	Type	Description
permissionName	string	The name of the permission. `account-company-info` `account-user-management` `account-viewer` `tenant-viewer` `tenant-manage-settings` `tenant-agent-install` `tenant-logviewer` `tenant-view-sensitive-request-data` `tenant-configure-request-capture-data` `tenant-replay-sessions-with-masking` `tenant-replay-sessions-without-masking` `tenant-manage-security-problems` `tenant-manage-support-tickets`
scope	string	The scope of the permission. Depending on the scope type, it is defined by: `account`: The UUID of the account. `tenant`: The ID of the environment. `management-zone`: The ID of the management zone from an environment in `{environment-id}:{management-zone-id}` format.
scopeType	string	The type of the permission scope. `account` `tenant` `management-zone`
createdAt	string	The date and time of the permission creation in `2021-05-01T15:11:00Z` format.
updatedAt	string	The date and time of the most recent permission modification in `2021-05-01T15:11:00Z` format.

Response body JSON model

{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "federatedAttributeValues": [
    "string"
  ],
  "owner": "LOCAL",
  "createdAt": "string",
  "updatedAt": "string",
  "permissions": [
    {
      "permissionName": "account-company-info",
      "scope": "string",
      "scopeType": "account",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

Example

In this example, the request lists permissions of the user group with the UUID of 752d4f22-83f9-44dd-8fb2-7f226354fdb5.

Curl

curl --request GET \
  --url 'https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups/752d4f22-83f9-44dd-8fb2-7f226354fdb5/permissions' \
  --header 'Authorization: Bearer abcdefjhij1234567890'

Request URL

https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups/752d4f22-83f9-44dd-8fb2-7f226354fdb5/permissions

Response body

{
  "uuid": "752d4f22-83f9-44dd-8fb2-7f226354fdb5",
  "name": "Finance admin",
  "owner": "LOCAL",
  "description": null,
  "hidden": false,
  "createdAt": "2020-03-11T03:01:00Z",
  "updatedAt": "2020-03-11T03:01:00Z",
  "permissions": [
    {
      "permissionName": "account-viewer",
      "scope": "9ad20784-76c6-4167-bfba-9b0d8d72a71d",
      "scopeType": "account",
      "createdAt": "2020-03-11T03:01:00Z",
      "updatedAt": "2020-03-11T03:01:00Z"
    },
    {
      "permissionName": "account-company-info",
      "scope": "9ad20784-76c6-4167-bfba-9b0d8d72a71d",
      "scopeType": "account",
      "createdAt": "2020-03-11T03:01:00Z",
      "updatedAt": "2020-03-11T03:01:00Z"
    }
  ]
}

Response code

200