• Home
  • API
  • Account management
  • Group management
  • GET all groups

Group management API - GET all groups

Lists all user groups of your Dynatrace account.

The request produces an application/json payload.

GET

https://api.dynatrace.com/iam/v1/accounts/{accountUuid}/groups

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

ParameterTypeDescriptionInRequired
accountUuidstring

The ID of the required account.

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

pathrequired

Response

Response codes

CodeTypeDescription
200GroupListDto

Success. The response contains the list of user groups.

Response body objects

The GroupListDto object

ElementTypeDescription
countnumber

The number of entries in the list.

itemsGetGroupDto[]-

The GetGroupDto object

ElementTypeDescription
uuidstring

The UUID of the user group.

namestring

The name of the user group.

descriptionstring

A short description of the user group.

federatedAttributeValuesstring[]

A list of values associating this group with the corresponding claim from an identity provider.

ownerstring

The identity provider from which the group originates.

The element can hold these values
  • LOCAL
  • SCIM
  • SAML
  • DCS
createdAtstring

The date and time of the group creation in 2021-05-01T15:11:00Z format.

updatedAtstring

The date and time of the most recent group modification in 2021-05-01T15:11:00Z format.

Response body JSON model

json
{ "count": 1, "items": [ { "uuid": "string", "name": "string", "description": "string", "federatedAttributeValues": [ "string" ], "owner": "LOCAL", "createdAt": "string", "updatedAt": "string" } ] }

Example

In this example, the request lists all user groups of the of the 2b794097-8ad2-4b32-b923-0131da2eeddf account. The example result is truncated to three entries.

Curl

bash
curl --request GET \ --url 'https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups' \ --header 'Authorization: Bearer abcdefjhij1234567890'

Request URL

http
https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups

Response body

json
{ "count": 14, "items": [ { "uuid": "7a1d224d-0ebc-4318-ab1e-64b217b7c156", "name": "Monitoring viewer", "owner": "LOCAL", "description": null, "hidden": false, "createdAt": "2020-03-11T03:01:00Z", "updatedAt": "2020-03-11T03:01:00Z" }, { "uuid": "f335c6ae-f046-48ad-a0a2-49bb8fdca07b", "name": "Monitoring admin", "owner": "LOCAL", "description": null, "hidden": false, "createdAt": "2020-03-11T03:01:00Z", "updatedAt": "2020-03-11T03:01:00Z" }, { "uuid": "56d56aba-c12f-44c1-a0ba-42eba3e3ff84", "name": "Account manager", "owner": "LOCAL", "description": null, "hidden": false, "createdAt": "2020-03-11T03:01:00Z", "updatedAt": "2020-03-11T03:01:00Z" } ] }

Response code

200