User management API - GET all users
Lists all users of an 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 Authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
accountUuid | string | The ID of the required account. You can find the UUID on the Account > Account management API page, during creation of an OAuth client. | path | required |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | User | Success. The response contains the list of users. |
Response body objects
The UserListDto
object
Element | Type | Description |
---|---|---|
count | number | The number of entries in the list. |
items | Users | A list of the account's users. |
The UsersDto
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 ( |
userLoginMetadata | User | - |
The UserLoginMetaDataDto
object
Element | Type | Description |
---|---|---|
successfulLoginCounter | number | The number of successful sign-ins. |
failedLoginCounter | number | The number of failed sign-ins. |
lastSuccessfulLogin | string | The date and time of the most recent successful sign-in in |
lastFailedLogin | string | The date and time of the most recent failed sign-in in |
createdAt | string | The date and time of user creation in |
updatedAt | string | The date and time of the most recent modification to the user in |
Response body JSON model
{
"count": 1,
"items": [
{
"uid": "string",
"email": "string",
"name": "string",
"surname": "string",
"userStatus": "ACTIVE",
"emergencyContact": true,
"userLoginMetadata": {
"successfulLoginCounter": 1,
"failedLoginCounter": 1,
"lastSuccessfulLogin": "string",
"lastFailedLogin": "string",
"createdAt": "string",
"updatedAt": "string"
}
}
]
}
Example
In this example, the request lists all users of the 2b794097-8ad2-4b32-b923-0131da2eeddf account. The result is truncated to two entries.
Curl
curl --request GET \
--url 'https://api.dynatrace.com/iam/v1/accounts/2b794097-8ad2-4b32-b923-0131da2eeddf/users' \
--header 'Authorization: Bearer abcdefjhij1234567890'
Request URL
https://api.dynatrace.com/iam/v1/accounts/2b794097-8ad2-4b32-b923-0131da2eeddf/users
Response body
{
"count": 2,
"items": [
{
"uid": "44fc26d0-ed1f-4fbd-96e8-5da7c192f9c1",
"email": "john.smith@company.com",
"name": "John",
"surname": "Smith",
"emergencyContact": true,
"userStatus": "ACTIVE",
"userLoginMetadata": {
"successfulLoginCounter": 1260,
"failedLoginCounter": 0,
"lastSuccessfulLogin": "2020-03-11T03:01:00Z",
"lastFailedLogin": null,
"resetPasswordTokenSentAt": null,
"lastSuccessfulBasicAuthentication": null,
"createdAt": "2020-03-11T03:01:00Z",
"updatedAt": "2020-03-11T03:01:00Z"
}
},
{
"uid": "20cc1c46-870e-48ca-ac40-9a8459cf6632",
"email": "jane.brown@company.com",
"name": "Jane",
"surname": "Brown",
"emergencyContact": false,
"userStatus": "ACTIVE",
"userLoginMetadata": {
"successfulLoginCounter": 808,
"failedLoginCounter": 0,
"lastSuccessfulLogin": "2020-03-11T03:01:00Z",
"lastFailedLogin": null,
"resetPasswordTokenSentAt": null,
"lastSuccessfulBasicAuthentication": null,
"createdAt": "2020-03-11T03:01:00Z",
"updatedAt": "2020-03-11T03:01:00Z"
}
}
]
}
Response code
200