• Home
  • Dynatrace API
  • Account management
  • Group management
  • POST a new group

Group management API - POST a new group

Creates a new user group in your Dynatrace account.

The request consumes and produces an application/json payload.

POST

https://api.dynatrace.com/iam/v1/accounts/{accountUuid}/groups

Authentication

To execute this request, you need the Allow write access for identity resources (users and groups) (account-idm-write) scope assigned to your token. To learn how to obtain and use it, see Authentication.

Parameters

ParameterTypeDescriptionInRequired
accountUuidstring

The ID of the required account.

You can find the UUID on the Account > Account management API page, during creation of an OAuth client.

pathrequired
bodyPutGroupDto[]

The body of the request. Contains a list of configurations for new groups.

Do not specify a UUID. A UUID is assigned automatically by Dynatrace.

bodyrequired

Request body objects

The RequestBody object

The object doesn't provide any parameters.

The PutGroupDto object

ElementTypeDescriptionRequired
uuidstring

The UUID of the user group.

optional
namestring

The name of the user group.

required
descriptionstring

A short description of the user group.

optional
federatedAttributeValuesstring[]

A list of values associating this group with the corresponding claim from an identity provider.

optional

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.

json
[ { "uuid": "string", "name": "string", "description": "string", "federatedAttributeValues": [ "string" ] } ]

Response

Response codes

CodeTypeDescription
201GetGroupDto[]

Success. The response contains descriptions of newly created groups.

Response body objects

The ResponseBody object

The object doesn't provide any parameters.

The GetGroupDto object

ElementTypeDescription
uuidstring

The UUID of the user group.

namestring

The name of the user group.

descriptionstring

A short description of the user group.

federatedAttributeValuesstring[]

A list of values associating this group with the corresponding claim from an identity provider.

ownerstring

The identity provider from which the group originates.

The element can hold these values
  • LOCAL
  • SCIM
  • SAML
  • DCS
createdAtstring

The date and time of the group creation in 2021-05-01T15:11:00Z format.

updatedAtstring

The date and time of the most recent group modification in 2021-05-01T15:11:00Z format.

Response body JSON model

json
[ { "uuid": "string", "name": "string", "description": "string", "federatedAttributeValues": [ "string" ], "owner": "LOCAL", "createdAt": "string", "updatedAt": "string" } ]

Example

In this example, the request creates a new group with the name REST example.

Curl

bash
curl --request POST \ --url 'https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups' \ --header 'Authorization: Bearer abcdefjhij1234567890' \ --header 'Content-Type: application/json' \ --data '[ { "name": "REST example", "description": "An example of API call", "federatedAttributeValues": [ ] } ]'

Request URL

http
https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups

Request body

json
[ { "name": "REST example", "description": "An example of API call", "federatedAttributeValues": [ ] } ]

Response body

json
[ { "uuid": "a468e0e0-ef8f-45d8-9b0f-e016984d838b", "name": "REST example", "owner": "LOCAL", "description": "An example of API call", "hidden": false, "createdAt": null, "updatedAt": null } ]

Response code

201