Get management zones for user group
This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.
This API call retrieves information on management zone permissions for specific user group.
Authentication
To execute this request, you need the Service Provider API (ServiceProviderAPI
) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.
Endpoint
/api/v1.0/onpremise/groups/managementZones
Parameter
Parameter | Type | Description | In | Required |
---|---|---|---|---|
groupId | string | Group ID path parameter. Missing or empty values will return a 'Bad Request'. | path | required |
includeEmptyEntries | boolean | Should include empty entries in response | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | MzPermissionsForGroup | Success |
400 | - | No ID information received for the request to get group MZ permissions |
404 | - | Group not found |
Response body objects
The MzPermissionsForGroup
object
Element | Type | Description |
---|---|---|
groupId | string | Group ID |
mzPermissionsPerEnvironment | MzListForEnvironment[] | List of management zone permissions per environment |
The MzListForEnvironment
object
Element | Type | Description |
---|---|---|
environmentUuid | string | Environment UUID |
mzPermissions | MzPermissionsList[] | List of management zone models with permissions |
The MzPermissionsList
object
Element | Type | Description |
---|---|---|
mzId | string | The ID of the required management zone |
permissions | string[] | The list of permissions for the required management zone
|
Response body JSON model
1{2 "groupId": "string",3 "mzPermissionsPerEnvironment": [4 {5 "environmentUuid": "string",6 "mzPermissions": [7 {8 "mzId": "string",9 "permissions": [10 "DEMO_USER"11 ]12 }13 ]14 }15 ]16}
Example
This API call retrieves information on management zone permissions for salesgroup
user group.
Curl
1curl -X 'GET' \2 'https://mymanaged.cluster.com/api/v1.0/onpremise/groups/managementZones/salesgroup' \3 -H 'accept: application/json' \4 -H 'Authorization: Api-Token dt0c01.FDAI5YOMUQDKWFTPGON3V7SR.IE7R5J2Q4ZX5G67EKBTW7GT7T2H4GL3O6BV7CT53CCITSSS35PA3HAQDSJGY4C7W'
Request URL
1https://mymanaged.cluster.com/api/v1.0/onpremise/groups/managementZones/salesgroup
Response body
1{2 "groupId": "salesgroup",3 "mzPermissionsPerEnvironment": [4 {5 "environmentUuid": "5c6cf54c-5fe3-47e8-af18-54439090370b",6 "mzPermissions": [7 {8 "mzId": "-3223778520145835472",9 "permissions": [10 "REPLAY_SESSION_DATA",11 "VIEWER",12 "MANAGE_SECURITY_PROBLEMS",13 "REPLAY_SESSION_DATA_WITHOUT_MASKING"14 ]15 }16 ]17}
Response code
200