Group management API - GET all groups
Lists all user groups of your Dynatrace account.
The request produces an application/json
payload.
GET |
|
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 OAuth clients.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
accountUuid | string | The ID of the required account. You can find the UUID on the Account Management > Identity & access management > OAuth clients page, during creation of an OAuth client. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Group | Success. The response contains the list of user groups. |
Response body objects
The GroupListDto
object
Element | Type | Description |
---|---|---|
count | number | The number of entries in the list. |
items | Get | - |
The GetGroupDto
object
Element | Type | Description |
---|---|---|
uuid | string | The UUID of the user group. |
name | string | The name of the user group. |
description | string | A short description of the user group. |
federatedAttributeValues | string[] | A list of values associating this group with the corresponding claim from an identity provider. |
owner | string | The type of the group.
|
createdAt | string | The date and time of the group creation in |
updatedAt | string | The date and time of the most recent group modification in |
Response body JSON model
{"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
curl --request GET \--url 'https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups' \--header 'Authorization: Bearer abcdefjhij1234567890'
Request URL
https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups
Response body
{"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