Try it free

List visible groups for an organizational level

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List visible groups in Dynatrace for an organizational level with the IAM API, filtered by group UUIDs or partialGroupName and returned by your access rights.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/iam/v1/organizational-levels/{level-type}/{level-id}/groups

Overview

It is required to provide at either request body containing list of group uuids or partialGroupName. If both are provided then the result returns groups meeting any of the provided criteria. Authorization is based on an assignment of the calling user to the account associated with the 'level-type' and 'level-id' For environment 'level-type' user has to be assigned to account to which the environment is assigned, user does not need any permissions in such environment

Authentication

To execute this request, you need a platform token or OAuth access token with iam:groups:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
level-typestring

Allowed values: account, environment

pathRequired
level-idstring

Identifier of 'level-type'. Max allowed length is 36. For account use its UUID. For environment 'level-type' user has to be assigned to account to which the environment is assigned, user does not need any permissions in such environment

pathRequired
partialGroupNamestring

Filter value - contains. Minimum length: 3. Maximum length: 320

queryOptional
page-keystring

Cursor-based Pagination - page-key. Cursor to the next page, includes page number and filtering values. Implicit filtering values will be overwritten by page-key property. Cursor-based Pagination can't be used together with Offset-based Pagination! Max length: 2000

queryOptional
pageinteger

Offset-based Pagination - page. Default value: 1. Page number to return. Offset-based Pagination can't be used with Cursor-based Pagination!

queryOptional
pageSizeinteger

Pagination - page size. Default value: 1000. Minimum value: 1. Maximum value: 1000

queryOptional
bodystring[]

List of group UUIDs. Filter value - equals. Allows multiple values. Maximum allowed size: 100

bodyOptional

Request body objects

The RequestBody object

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

[
"string"
]

Response

Response codes

CodeTypeDescription
200RestGroupPublicListResponse

Groups from the level fetched successfully

400PublicExceptionMessage

Missing both 'partialGroupName' and 'uuid' filter values, or the values don't meet requirements.

401PublicExceptionMessage

Authorization header is missing or is incorrect.

403PublicExceptionMessage

Execution user is not allowed to perform the action.

404PublicExceptionMessage

Calling user is not assigned to the requested account or requested environment is not assigned to account that user is assigned to or the 'level-id' does not exist

429PublicExceptionThrottlingMessage

Too many requests have been sent - requests are throttled

Response body objects

The RestGroupPublicListResponse object

ElementTypeDescription
resultsRestGroupPublic[]

Collection containing the paginated result

nextPageKeystring

Key for requesting the next page of the result

totalCountinteger

Total count of records

The RestGroupPublic object

Collection containing the paginated result

ElementTypeDescription
uuidstring-
groupNamestring-
typestring-
The element can hold these values
  • LOCAL
  • ALL_USERS
  • SCIM
  • SAML

The PublicExceptionMessage object

ElementTypeDescription
errorErrorResponse-

The ErrorResponse object

ElementTypeDescription
codeinteger-
messagestring-
detailsErrorResponseDetails-

The ErrorResponseDetails object

ElementTypeDescription
missingScopesstring[]-
constraintViolationsErrorResponseConstraintViolation[]-

The ErrorResponseConstraintViolation object

ElementTypeDescription
pathstring-
messagestring-
parameterLocationstring-

Response body JSON models

{
"results": [
{
"uuid": "string",
"groupName": "string",
"type": "LOCAL"
}
],
"nextPageKey": "string",
"totalCount": 1
}
{
"error": {
"code": 1,
"message": "string",
"details": {
"missingScopes": [
"string"
],
"constraintViolations": [
{
"path": "string",
"message": "string",
"parameterLocation": "string"
}
]
}
}
}
Related tags
Platform APIDynatrace Platform