List visible groups from a Dynatrace IAM organizational level with the Identity and Access Management API, filtering by partialGroupName or group UUIDs.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/iam/v1/organizational-levels/{level-type}/{level-id}/groups |
Providing value for at least one of the parameters: 'partialGroupName' or 'uuid' is required. If both query params 'partialGroupName' and 'uuid' are provided then the result will be all of the groups meeting any of the filtering 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
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| level-type | string | Allowed values: account, environment | path | Required |
| level-id | string | 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 | path | Required |
| partialGroupName | string | Filter value - contains. Minimum length: 3. Maximum length: 320 | query | Optional |
| uuid | string[] | List of group UUIDs. Filter value - equals. Allows definition of multiple values. Maximum allowed size: 10 | query | Optional |
| page-key | string | 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 | query | Optional |
| page | integer | Offset-based Pagination - page. Default value: 1. Page number to return. Offset-based Pagination can't be used with Cursor-based Pagination! | query | Optional |
| pageSize | integer | Pagination - page size. Default value: 1000. Minimum value: 1. Maximum value: 1000 | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Rest | Groups from the level fetched successfully |
| 400 | Public | Missing both 'partialGroupName' and 'uuid' filter values, or the values don't meet the requirements. |
| 401 | Public | Authorization header is missing or is incorrect. |
| 403 | Public | Execution user is not allowed to perform the action. |
| 404 | Public | 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 |
| 429 | Public | Too many requests have been sent - requests are throttled |
RestGroupPublicListResponse object| Element | Type | Description |
|---|---|---|
| results | Rest | Collection containing the paginated result |
| nextPageKey | string | Key for requesting the next page of the result |
| totalCount | integer | Total count of records |
RestGroupPublic objectCollection containing the paginated result
| Element | Type | Description |
|---|---|---|
| uuid | string | - |
| groupName | string | - |
| type | string | -The element can hold these values
|
PublicExceptionMessage object| Element | Type | Description |
|---|---|---|
| error | Error | - |
ErrorResponse object| Element | Type | Description |
|---|---|---|
| code | integer | - |
| message | string | - |
| details | Error | - |
ErrorResponseDetails object| Element | Type | Description |
|---|---|---|
| missingScopes | string[] | - |
| constraintViolations | Error | - |
ErrorResponseConstraintViolation object| Element | Type | Description |
|---|---|---|
| path | string | - |
| message | string | - |
| parameterLocation | string | - |
{"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"}]}}}