Dynatrace · Schema

UserCollection

A paginated collection of users.

AI OperationsAnalyticsAPMApplication Performance MonitoringApplication SecurityAutomationCloud MonitoringDigital Experience ManagementIntelligenceObservability

Properties

Name Type Description
nextPageKey string Cursor for the next page of results.
totalCount integer The total number of users in the account.
items array The list of users on this page.
View JSON Schema on GitHub

JSON Schema

dynatrace-account-management-user-collection-schema.json Raw ↑
{
  "type": "object",
  "description": "A paginated collection of users.",
  "properties": {
    "nextPageKey": {
      "type": "string",
      "description": "Cursor for the next page of results.",
      "example": "example-value"
    },
    "totalCount": {
      "type": "integer",
      "description": "The total number of users in the account.",
      "format": "int64",
      "example": 500
    },
    "items": {
      "type": "array",
      "description": "The list of users on this page.",
      "example": [
        {
          "uid": "abc123",
          "email": "[email protected]",
          "firstName": "Production Service",
          "lastName": "Production Service",
          "groups": [
            "example-value"
          ],
          "userStatus": "ACTIVE"
        }
      ],
      "items": {
        "type": "object",
        "description": "Represents a user in the Dynatrace account.",
        "properties": {
          "uid": {
            "type": "string",
            "description": "The unique identifier of the user.",
            "example": "abc123"
          },
          "email": {
            "type": "string",
            "description": "The email address of the user, used as their login identifier.",
            "format": "email",
            "example": "[email protected]"
          },
          "firstName": {
            "type": "string",
            "description": "The first name of the user.",
            "example": "Production Service"
          },
          "lastName": {
            "type": "string",
            "description": "The last name of the user.",
            "example": "Production Service"
          },
          "groups": {
            "type": "array",
            "description": "The list of group IDs that the user belongs to.",
            "example": [
              "example-value"
            ],
            "items": {
              "type": "string"
            }
          },
          "userStatus": {
            "type": "string",
            "description": "The current status of the user account.",
            "example": "ACTIVE",
            "enum": [
              "ACTIVE",
              "INACTIVE",
              "PENDING_INVITE"
            ]
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UserCollection"
}