Get user group

This API call retrieves information on a specific cluster 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

Parameter

Parameter	Type	Description	In	Required
groupId	string	Group ID path parameter. Missing or empty values will return a 'Bad Request'.	path	required

Response

Response codes

Code	Type	Description
200	GroupConfig	Success
400		No ID information received for the request to get a group
404		Not found

Response body objects

The `GroupConfig` object

The configuration of the group.

Element	Type	Description
isClusterAdminGroup	boolean	If true, then the group has the cluster administrator rights.
hasAccessAccountRole	boolean	If true, then the group has the access account rights.
hasManageAccountAndViewProductUsageRole	boolean	If true, then the group has the manage account rights.
isAccessAccount	boolean	-
isManageAccount	boolean	-
id	string	Group ID. Leave empty if creating group. Set if updating group.
name	string	Group name
ldapGroupNames	string[]	LDAP group names
ssoGroupNames	string[]	SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
accessRight	object	Access rights

Response body JSON model

json
{
  "isClusterAdminGroup": true,
  "hasAccessAccountRole": true,
  "hasManageAccountAndViewProductUsageRole": true,
  "isAccessAccount": true,
  "isManageAccount": true,
  "id": "string",
  "name": "string",
  "ldapGroupNames": [
    "string"
  ],
  "ssoGroupNames": [
    "string"
  ],
  "accessRight": {}
}

Example

In this example, you retrieve salesgroup user group details.

Curl

bash
curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/groups/salesgroup" -H  "accept: application/json" -H 'Authorization: Api-Token FG563.LKJHDFLKJHDFHLKJDGV.ABCDEFGHJKLMNOP'

Request URL

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

Response body

json
{
  "isClusterAdminGroup": true,
  "isAccessAccount": true,
  "isManageAccount": true,
  "id": "salesgroup",
  "name": "Sales Group",
  "ldapGroupNames": [
    "sales"
  ]
  }

Response code

200