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 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
body

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.

body
required

Request body objects

The RequestBody object

The PutGroupDto object

Element
Type
Description
Required
uuid
string

The UUID of the user group.

optional
name
string

The name of the user group.

required
description
string

A short description of the user group.

optional
federatedAttributeValues
string[]

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

If present and the group has owner = LOCAL, then group owner is set to SAML.

If missing and the group has owner = SAML, then group owner is set to LOCAL.

Cannot set this value for groups having owner set to SCIM or ALL_USERS.

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.

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

Response

Response codes

Code
Type
Description
201

Success. The response contains descriptions of newly created groups.

Response body objects

The ResponseBody object

The GetGroupDto object

Element
Type
Description
uuid
string

The UUID of the user group.

name
string

The name of the user group.

description
string

A short description of the user group.

federatedAttributeValues
string[]

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

owner
string

The type of the group. LOCAL, SCIM, SAML and DCS corresponds to the identity provider from which the group originates. ALL_USERS is a special case of LOCAL group. It means that group is always assigned to all users in the account.

  • LOCAL
  • SCIM
  • SAML
  • DCS
  • ALL_USERS
createdAt
string

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

updatedAt
string

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

Response body JSON model

[
  {
    "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

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

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

Request body

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


    ]
  }
]

Response body

[
  {
    "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