User management API - GET all users

Latest Dynatrace
Reference
Published Jul 25, 2022

Lists all users of an account.

The request produces an application/json payload.

GET	`https://api.dynatrace.com/iam/v1/accounts/{accountUuid}/users`

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
service-users	boolean	Specifies whether service users are included in results.	query	optional

Parameter

Type

Description

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

service-users

boolean

Specifies whether service users are included in results.

query

optional

Response

Response codes

Code	Type	Description
200	UserListDto	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	UsersDto[]	A list of the account's users.

The `UsersDto` object

Element	Type	Description
uid	string	The UUID of the user.
email	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: `ACTIVE`: The user is active. `INACTIVE`: The user is deactivated and cannot sign in to Dynatrace. `PENDING`: The user received an invitation, but hasn't completed sign-up yet. `DELETED`: The user was deleted and cannot sign in to Dynatrace anymore. `ECUSTOMS_MANUALLY_BLOCKED`: The user is blocked due to to a trade and export compliance violation. `ACTIVE` `INACTIVE` `PENDING` `DELETED` `ECUSTOMS_MANUALLY_BLOCKED`
emergencyContact	boolean	The user is (`true`) or is not (`false`) an emergency contact for the account.
userLoginMetadata	UserLoginMetaDataDto	Available if user has logged into Dynatrace at least once

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 `2021-05-01T15:11:00Z` format.
lastFailedLogin	string	The date and time of the most recent failed sign-in in `2021-05-01T15:11:00Z` format.
createdAt	string	The date and time of user creation in `2021-05-01T15:11:00Z` format.
updatedAt	string	The date and time of the most recent modification to the user in `2021-05-01T15:11:00Z` format.

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