Updates parameters of a user group.
The request consumes an application/json payload.
PUT |
|
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.
| 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 |
| groupUuid | string | The UUID of the required user group. | path | required |
| body | Put | The body of the request. Contains the updated parameters of the group. You can't change the UUID of the group. | body | required |
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 = If missing and the group has owner = Cannot set this value for groups having owner set to | optional |
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"]}
| Code | Description |
|---|---|
| 200 | Success. The group has been modified. The response doesn't have a body. |
In this example, the request updates the configuration of the user group created in the POST request example. The response code of 200 indicates that the modification was successful.
curl --request PUT \--url 'https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups/bd4027ea-90de-48cb-90ff-9dc390517b74' \--header 'Authorization: Bearer abcdefjhij1234567890' \--header 'Content-Type: application/json' \--data '{"uuid": "a468e0e0-ef8f-45d8-9b0f-e016984d838b","name": "REST example - update","description": "An updated example of API call","federatedAttributeValues": []}'
https://api.dynatrace.com/iam/v1/accounts/9ad20784-76c6-4167-bfba-9b0d8d72a71d/groups/bd4027ea-90de-48cb-90ff-9dc390517b74
{"uuid": "a468e0e0-ef8f-45d8-9b0f-e016984d838b","name": "REST example - update","description": "An updated example of API call","federatedAttributeValues": []}
200