Get management zones for user group

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

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

List of management zone permissions per environment

The MzListForEnvironment object

Element
Type
Description
environmentUuid
string

Environment UUID

mzPermissions

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

  • DEMO_USER
  • LOG_VIEWER
  • MANAGE_SECURITY_PROBLEMS
  • MANAGE_SETTINGS
  • REPLAY_SESSION_DATA
  • REPLAY_SESSION_DATA_WITHOUT_MASKING
  • VIEWER
  • VIEW_SECURITY_PROBLEMS
  • VIEW_SENSITIVE_REQUEST_DATA

Response body JSON model

{
  "groupId": "string",
  "mzPermissionsPerEnvironment": [
    {
      "environmentUuid": "string",
      "mzPermissions": [
        {
          "mzId": "string",
          "permissions": [
            "DEMO_USER"
          ]
        }
      ]
    }
  ]
}

Example

This API call retrieves information on management zone permissions for salesgroup user group.

Curl

curl -X 'GET' \
  'https://mymanaged.cluster.com/api/v1.0/onpremise/groups/managementZones/salesgroup' \
  -H 'accept: application/json' \
  -H 'Authorization: Api-Token dt0c01.FDAI5YOMUQDKWFTPGON3V7SR.IE7R5J2Q4ZX5G67EKBTW7GT7T2H4GL3O6BV7CT53CCITSSS35PA3HAQDSJGY4C7W'

Request URL

https://mymanaged.cluster.com/api/v1.0/onpremise/groups/managementZones/salesgroup

Response body

{
  "groupId": "salesgroup",
  "mzPermissionsPerEnvironment": [
    {
      "environmentUuid": "5c6cf54c-5fe3-47e8-af18-54439090370b",
      "mzPermissions": [
        {
          "mzId": "-3223778520145835472",
          "permissions": [
            "REPLAY_SESSION_DATA",
            "VIEWER",
            "MANAGE_SECURITY_PROBLEMS",
            "REPLAY_SESSION_DATA_WITHOUT_MASKING"
          ]
        }
  ]
}

Response code

200