Try it free

Add permissions to a settings object

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Add permissions for one accessor on a settings object in Dynatrace with the App Settings API, using the object ID and permission details.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/v2/objects/{object-id}/permissions

Overview

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 accessor and permissions, and the response confirms the permission was created.

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
object-idstring

The ID of the required settings object

pathRequired
admin-accessboolean

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

queryOptional
bodyAppSettingsAccessorPermissions-bodyRequired

Request body objects

The AppSettingsAccessorPermissions object

ElementTypeDescriptionRequired
accessorIdentity-Required
permissionsAppSettingsPermissionsList[]

Permissions 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.

The element can hold these values
  • r
  • w
Required

The Identity object

ElementTypeDescriptionRequired
typestring-
The element can hold these values
  • user
  • group
  • all-users
Required
idstring

user id or user group id if type is 'user' or 'group', missing if type is 'all-users'

Optional

The AppSettingsPermissionsList object

Permissions 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.

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.

{
  "accessor": {
    "type": "user",
    "id": "string"
  },
  "permissions": [
    "r",
    "w"
  ]
}

Response

Response codes

CodeTypeDescription
201AppSettingsAccessorPermissions

Success

400ErrorResponse

if accessor id already exists

404ErrorResponse

No object available for the given objectId

429--
503--
4XX--
5XX--

Response body objects

The AppSettingsAccessorPermissions object

ElementTypeDescription
accessorIdentity-
permissionsAppSettingsPermissionsList[]

Permissions 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.

The element can hold these values
  • r
  • w

The Identity object

ElementTypeDescription
typestring-
The element can hold these values
  • user
  • group
  • all-users
idstring

user id or user group id if type is 'user' or 'group', missing if type is 'all-users'

The AppSettingsPermissionsList object

Permissions 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.

The ErrorResponse object

ElementTypeDescription
errorError

Standard error response

The Error object

Standard error response

ElementTypeDescription
codenumber

The error code (HTTP response)

messagestring

The error message

retryAfterSecondsnumber

Number of seconds a request can be retried after a 'too many requests' error response.

detailsErrorDetails

Optional details of the error

The ErrorDetails object

Optional details of the error

ElementTypeDescription
errorRefstring

reference to the error occurrence in the internal self-monitoring, logging, etc.

constraintViolationsConstraintViolation[]

A list of constraint violations of input parameters (path, query, request body)

missingScopesstring[]

In case of a 403 - Forbidden response, a list of missing scopes necessary to successfully execute the request

The ConstraintViolation object

Contains information about a constraint violation caused by invalid input.

ElementTypeDescription
pathstring

The path of the parameter that caused the constraint violation

messagestring

The constraint violation description message

parameterLocationstring

Describes the general location of the violating parameter

The element can hold these values
  • PATH
  • QUERY
  • HEADER
  • PAYLOAD_BODY

Response body JSON models

{
  "accessor": {
    "type": "user",
    "id": "string"
  },
  "permissions": [
    "r",
    "w"
  ]
}
{
  "error": {
    "code": 1,
    "message": "string",
    "retryAfterSeconds": 1,
    "details": {
      "errorRef": "string",
      "constraintViolations": [
        {
          "path": "string",
          "message": "string",
          "parameterLocation": "PATH"
        }
      ],
      "missingScopes": [
        "string"
      ]
    }
  }
}
Related tags
Platform APIDynatrace Platform