Service user management API - GET all service users

Latest Dynatrace
Reference
Published Dec 04, 2025

Lists all service users of your Dynatrace account.

The request produces an application/json payload.

GET

https://api.dynatrace.com/iam/v1/accounts/{accountUuid}/service-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
page	integer	The number of the requested page. Can be increased as long as nextPageKey is available in the response.	query	Optional
page-size	integer	Defines the requested number of entries for the next page.	query	Optional
page-key	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.	query	Optional

Response

Response codes

Code	Type	Description
200	ExternalServiceUsersPageDto	Success. Service users assigned to account fetched successfully.

Response body objects

The `ExternalServiceUsersPageDto` object

Element	Type	Description
results	ExternalServiceUserDto[]	-
nextPageKey	string	Next page key to be used in querying for next results page
totalCount	number	Total number of service users

The `ExternalServiceUserDto` object

Element	Type	Description
uid	string	UUID of service user
email	string	Email of service user
name	string	Name of service user
surname	string	Surname of service user
description	string	The description of the service user
createdAt	string	The date and time when the user was created in `2021-05-01T15:11:00Z` format.

Response body JSON models

{
  "results": [
    {
      "uid": "string",
      "email": "string",
      "name": "string",
      "surname": "string",
      "description": "string",
      "createdAt": "string"
    }
  ],
  "nextPageKey": "string",
  "totalCount": 1
}

Example

In this example, the request lists all service users assigned to the account with accountUuid 2b794097-8ad2-4b32-b923-0131da2eeddf. The example result is truncated to three entries.

Curl

curl -X 'GET' \
  'https://api.dynatrace.com/spec/iam/v1/2b794097-8ad2-4b32-b923-0131da2eeddf/service-users?page-size=10' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eywedGciOiJFUzI1NiIsInR7cCI6IkpCDVIsImtpZCI6IjEifQ'

Request URL

https://api.dynatrace.com/spec/iam/v1/accounts/2b794097-8ad2-4b32-b923-0131da2eeddf/service-users?page-size=10

Response body

{
  "results": [
    {
      "uid": "f3a9c2e7-9b1d-4bfc-8d53-8a1e6b9c12fe",
      "login": "f3a9c2e7-9b1d-4bfc-8d53-8a1e6b9c12fe@service.sso.dynatrace.com",
      "email": "f3a9c2e7-9b1d-4bfc-8d53-8a1e6b9c12fe@service.sso.dynatrace.com",
      "name": "serviceUser1",
      "surname": "SERVICE_IDENTITY",
      "type": "SERVICE_EXTERNAL",
      "userStatus": "ACTIVE",
      "description": "",
      "createdAt": "2024-10-10T07:44:38Z"
    },
    {
      "uid": "7dbe1a44-2c8e-4f87-b5a9-3c4e0f9db7a2",
      "login": "7dbe1a44-2c8e-4f87-b5a9-3c4e0f9db7a2@service.sso.dynatrace.com",
      "email": "7dbe1a44-2c8e-4f87-b5a9-3c4e0f9db7a2@service.sso.dynatrace.com",
      "name": "serve2",
      "surname": "SERVICE_IDENTITY",
      "type": "SERVICE_EXTERNAL",
      "userStatus": "ACTIVE",
      "description": "serve",
      "createdAt": "2024-10-24T13:06:20Z"
    },
    {
      "uid": "c9f0b1a2-3d4e-4f10-8a2b-5c6d7e8f9012",
      "login": "c9f0b1a2-3d4e-4f10-8a2b-5c6d7e8f9012@service.sso.dynatrace.com",
      "email": "c9f0b1a2-3d4e-4f10-8a2b-5c6d7e8f9012@service.sso.dynatrace.com",
      "name": "serve3",
      "surname": "SERVICE_IDENTITY",
      "type": "SERVICE_EXTERNAL",
      "userStatus": "ACTIVE",
      "description": "",
      "createdAt": "2024-10-24T13:07:29Z"
    },
  ]
}

Response code

200