Get management zones for user groups
This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.
This API call retrieves information on a management zone permissions for all user groups.
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 |
---|---|---|---|---|
includeEmptyEntries | boolean | Should include empty entries in response | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | MzPermissionsForGroup[] | Success |
Response body objects
The ResponseBody
object
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 {3 "groupId": "string",4 "mzPermissionsPerEnvironment": [5 {6 "environmentUuid": "string",7 "mzPermissions": [8 {9 "mzId": "string",10 "permissions": [11 "DEMO_USER"12 ]13 }14 ]15 }16 ]17 }18]
Example
In this example, you retrieve management zones for all user groups.
Curl
1curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/groups/managementZones' \2 -H 'accept: application/json' \3 -H 'Authorization: Api-Token FG563.LKJHDFLKJHDFHLKJDGV.ABCDEFGHJKLMNOP'
Request URL
1https://mymanaged.cluster.com/api/v1.0/onpremise/onpremise/groups/managementZones
Response body
1[2 {3 "groupId": "aaa",4 "mzPermissionsPerEnvironment": [5 {6 "environmentUuid": "4667c7df-c41a-800a-2c81-3c789c24faac",7 "mzPermissions": []8 },9 {10 "environmentUuid": "702822e6-c4d5-98b6-68f0-2fa6e916d83a",11 "mzPermissions": [12 {13 "mzId": "1082937102825552837",14 "permissions": []15 },16 {17 "mzId": "3256863855844402130",18 "permissions": []19 },20 {21 "mzId": "9010752233197751135",22 "permissions": []23 },24 {25 "mzId": "6704521539267660126",26 "permissions": []27 },28 {29 "mzId": "9988288124425157928",30 "permissions": []31 },32 {33 "mzId": "3762222045561554923",34 "permissions": []35 }36 ]37 },38 {39 "environmentUuid": "ff484b4b-4391-109e-429f-ce16dac3325a",40 "mzPermissions": []41 },42 {43 "environmentUuid": "a3d7fa42-a74d-ebd6-8aee-003b6c2abd6f",44 "mzPermissions": []45 },46 {47 "environmentUuid": "75188d7f-4e59-d4d3-c1ab-cb6eb5a095b8",48 "mzPermissions": [49 {50 "mzId": "3695265796834015735",51 "permissions": []52 }53 ]54 },55 {56 "environmentUuid": "560db49c-c2f5-8d41-3811-1623e4c4dd17",57 "mzPermissions": []58 },59 {60 "environmentUuid": "96cfb5d9-94e9-e5a3-96e6-b4ecced9f0ec",61 "mzPermissions": []62 },63 {64 "environmentUuid": "7e6cb304-79c5-6b90-9168-60f16deb1b00",65 "mzPermissions": [66 {67 "mzId": "6978718201709411367",68 "permissions": []69 },70 {71 "mzId": "1884001224662458062",72 "permissions": []73 }74 ]75 }76 ]77 }78]
Response code
200