Create user groups
This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.
This API call creates multiple cluster user groups.
Authentication
The ServiceProviderAPI (Service Provider API) Api-Token scope is required to get the default realm password policy configuration using the Dynatrace API. With this API method, you can preset user's password by passing passwordClearText value. This is allowed only if a specific Feature Flag is enabled. To do this, Please contact a Dynatrace product expert via live chat within your environment..
Endpoint
/api/v1.0/onpremise/groups/bulk
Parameter
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | GroupConfig[] | - | body | optional |
Request body objects
The RequestBody object
The GroupConfig object
The configuration of the group.
| Element | Type | Description | Required |
|---|---|---|---|
| accessRight | object | Access rights | optional |
| id | string | Group ID. Leave empty if creating group. Set if updating group. | required |
| isAccessAccount | boolean | (only applicable for Dynatrace Platform Subscription license model) If true, then the group has the "Access account" rights. Users assigned to a group with this permission can access account.dynatrace.com service to see Dynatrace Platform Subscription utilization and manage license quotas. | optional |
| isClusterAdminGroup | boolean | If true, then the group has the "cluster administrator" rights. Users assigned to a group with this permission are automatically given administrator access rights for all environments. They have access to Cluster Management Console and can manage your monitoring environments and Dynatrace Server. Users assigned to groups with this permission can also: Add new Dynatrace Server nodes, upgrade Dynatrace Server, manage Dynatrace Managed users and user groups, install Dynatrace OneAgent into any monitoring environment, configure monitoring settings for any monitoring environment. | required |
| isManageAccount | boolean | If true, then the group has "Edit billing & account info" rights. Users assigned to a group with this permission can access myaccount.dynatrace.com service to see product usage statistics, license utilization and account information. | optional |
| ldapGroupNames | string[] | LDAP group names | optional |
| name | string | Group name | required |
| ssoGroupNames | string[] | SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name | 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.
1[2 {3 "accessRight": {},4 "id": "string",5 "isAccessAccount": true,6 "isClusterAdminGroup": true,7 "isManageAccount": true,8 "ldapGroupNames": [9 "string"10 ],11 "name": "string",12 "ssoGroupNames": [13 "string"14 ]15 }16]
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | GroupConfig[] | Success |
| 400 | - | No group information received for the create-group request |
| 406 | GroupConfig[] | Unacceptable or incomplete request. Some groups were added. |
Response body objects
The ResponseBody object
The GroupConfig object
The configuration of the group.
| Element | Type | Description |
|---|---|---|
| accessRight | object | Access rights |
| id | string | Group ID. Leave empty if creating group. Set if updating group. |
| isAccessAccount | boolean | (only applicable for Dynatrace Platform Subscription license model) If true, then the group has the "Access account" rights. Users assigned to a group with this permission can access account.dynatrace.com service to see Dynatrace Platform Subscription utilization and manage license quotas. |
| isClusterAdminGroup | boolean | If true, then the group has the "cluster administrator" rights. Users assigned to a group with this permission are automatically given administrator access rights for all environments. They have access to Cluster Management Console and can manage your monitoring environments and Dynatrace Server. Users assigned to groups with this permission can also: Add new Dynatrace Server nodes, upgrade Dynatrace Server, manage Dynatrace Managed users and user groups, install Dynatrace OneAgent into any monitoring environment, configure monitoring settings for any monitoring environment. |
| isManageAccount | boolean | If true, then the group has "Edit billing & account info" rights. Users assigned to a group with this permission can access myaccount.dynatrace.com service to see product usage statistics, license utilization and account information. |
| ldapGroupNames | string[] | LDAP group names |
| name | string | Group name |
| ssoGroupNames | string[] | SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name |
Response body JSON model
1[2 {3 "accessRight": {},4 "id": "string",5 "isAccessAccount": true,6 "isClusterAdminGroup": true,7 "isManageAccount": true,8 "ldapGroupNames": [9 "string"10 ],11 "name": "string",12 "ssoGroupNames": [13 "string"14 ]15 }16]
Example
In this example, you add user groups Sales Group and Developers in a single request. This will set their data and assign environment permissions. As a response, you will receive back persisted state of the entities.
Curl
1curl -X 'POST' \2 'https://mymanaged.cluster.com/api/v1.0/onpremise/groups/bulk' \3 -H 'accept: application/json' \4 -H 'Authorization: Api-Token FG563.LKJHDFLKJHDFHLKJDGV.ABCDEFGHJKLMNOP' \5 -H 'Content-Type: application/json' \6 -d '[7 {8 "isClusterAdminGroup": true,9 "isAccessAccount": true,10 "isManageAccount": true,11 "name": "Sales Group",12 "ldapGroupNames": [13 "sales-group"14 ],15 "ssoGroupNames": [16 "sales-group"17 ],18 "accessRight": {19 "VIEWER": [20 "3fcc5d83-d9e5-4bf9-9e00-d997f9c4c63d"21 ],22 "REPLAY_SESSION_DATA": [23 "3fcc5d83-d9e5-4bf9-9e00-d997f9c4c63d"24 ]25 }26 },27{28 "isClusterAdminGroup": true,29 "isAccessAccount": true,30 "isManageAccount": true,31 "name": "Developers",32 "ldapGroupNames": [33 "dev-group"34 ],35 "ssoGroupNames": [36 "dev-group"37 ],38 "accessRight": {39 "VIEWER": [40 "3fcc5d83-d9e5-4bf9-9e00-d997f9c4c63d"41 ]4243 }44 }4546]'
Request URL
1https://mymanaged.cluster.com/api/v1.0/onpremise/groups/bulk
Response body
1[2 {3 "isClusterAdminGroup": true,4 "isManageAccount": true,5 "isAccessAccount": true,6 "id": "salesgroup",7 "name": "Sales Group",8 "ldapGroupNames": [9 "sales-group"10 ],11 "ssoGroupNames": [12 "sales-group"13 ],14 "accessRight": {}15 },16 {17 "isClusterAdminGroup": true,18 "isManageAccount": true,19 "isAccessAccount": true,20 "id": "developers",21 "name": "Developers",22 "ldapGroupNames": [23 "dev-group"24 ],25 "ssoGroupNames": [26 "dev-group"27 ],28 "accessRight": {}29 }30]
Response code
200