Update all-users permissions for a settings object in Dynatrace with the App Settings API, using the object ID and permission values.
| PUT | SaaS | https://{your-environment-id}.apps.dynatrace.com/v2/objects/{object-id}/permissions/all-users |
You provide the object ID path parameter and can optionally set admin-access when you have app-settings:objects:admin permission. In the request body, you send permissions, and the response confirms the all-users permissions were updated.
To execute this request, you need a platform token or OAuth access token with app-settings:objects:write scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| object-id | string | The ID of the required settings object | path | Required |
| admin-access | boolean | If set to true and user has app-settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects | query | Optional |
| body | App | - | body | Required |
AppSettingsUpdatePermissionsRequest object| Element | Type | Description | Required |
|---|---|---|---|
| permissions | App | Permissions granted to the accessor on this object. The element can hold these values
| Required |
AppSettingsPermissionsList objectPermissions granted to the accessor on this object. r grants read access to view the object; w grants write access to modify the object. Valid values: ["r"] for read-only, ["r", "w"] for read and write.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"permissions": ["r","w"]}
| Code | Type | Description |
|---|---|---|
| 200 | - | success |
| 400 | Error | if permission list is empty, contains unsupported entries or unsupported combinations of entries |
| 404 | Error | No object available for the given objectId or the all-users accessor doesn't have any permissions on this object |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
ErrorResponse object| Element | Type | Description |
|---|---|---|
| error | Error | Standard error response |
Error objectStandard error response
| Element | Type | Description |
|---|---|---|
| code | number | The error code (HTTP response) |
| message | string | The error message |
| retryAfterSeconds | number | Number of seconds a request can be retried after a 'too many requests' error response. |
| details | Error | Optional details of the error |
ErrorDetails objectOptional details of the error
| Element | Type | Description |
|---|---|---|
| errorRef | string | reference to the error occurrence in the internal self-monitoring, logging, etc. |
| constraintViolations | Constraint | A list of constraint violations of input parameters (path, query, request body) |
| missingScopes | string[] | In case of a 403 - Forbidden response, a list of missing scopes necessary to successfully execute the request |
ConstraintViolation objectContains information about a constraint violation caused by invalid input.
| Element | Type | Description |
|---|---|---|
| path | string | The path of the parameter that caused the constraint violation |
| message | string | The constraint violation description message |
| parameterLocation | string | Describes the general location of the violating parameter The element can hold these values
|
{"error": {"code": 1,"message": "string","retryAfterSeconds": 1,"details": {"errorRef": "string","constraintViolations": [{"path": "string","message": "string","parameterLocation": "PATH"}],"missingScopes": ["string"]}}}