Group management API - GET group members
Lists all members of a user group.
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 Authentication.
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 |
groupUuid | string | The UUID of the required user group. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Group | Success. The response contains members of the group. |
Response body objects
The GroupUserListDto
object
Element | Type | Description |
---|---|---|
count | number | The number of entries in the list. |
items | User | - |
The UserDto
object
Element | Type | Description |
---|---|---|
uid | string | The UUID of the user. |
string | The email address of the user. | |
name | string | The first name of the user. |
surname | string | The last name of the user. |
userStatus | string | The status of this user in Dynatrace:
|
emergencyContact | boolean | The user is ( |
Response body JSON model
{"count": 1,"items": [{"uid": "string","email": "string","name": "string","surname": "string","userStatus": "ACTIVE","emergencyContact": true}]}
Example
In this example, the request lists the members of the user group with the UUID of 7a1d224d-0ebc-4318-ab1e-64b217b7c156. 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/7a1d224d-0ebc-4318-ab1e-64b217b7c156/users' \--header 'Authorization: Bearer abcdefjhij1234567890'
Request URL
https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups/7a1d224d-0ebc-4318-ab1e-64b217b7c156/users
Response body
{"count": 10,"items": [{"uid": "20cc1c46-870e-48ca-ac40-9a8459cf6632","email": "Jane.brown@company.com","name": "Jane","surname": "Brown","emergencyContact": false,"userStatus": "ACTIVE"},{"uid": "08dfae05-3bb9-4389-8c34-2ac0020c08b1","email": "john.smith@company.com","name": "John","surname": "Smith","emergencyContact": true,"userStatus": "ACTIVE"},{"uid": "d48faa11-a488-47c4-b56d-c7acd0e76ea1","email": "james.johnson@company.com","name": "James","surname": "Johnson","emergencyContact": false,"userStatus": "ACTIVE"}]}
Response code
200