Try it free

Settings API - POST object permission

  • Reference
  • Published Jul 09, 2026

Adds permissions for a single accessor on the specified settings object. Any user with read and write permissions on the object can add more permissions. The accessor ID must be a user or group UUID; use the User management API or Group management API to look up these identifiers.

This endpoint applies only to objects on schemas with owner-based access control enabled (ownerBasedAccessControl: true). To identify such schemas, include ownerBasedAccessControl in the add-fields parameter when calling List schemas.

The request consumes and produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/v2/settings/objects/{objectId}/permissions
POSTEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/v2/settings/objects/{objectId}/permissions

Parameters

ParameterTypeDescriptionInRequired
objectIdstring

The ID of the required settings object.

pathRequired
adminAccessboolean

If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects

queryOptional
bodyAccessorPermissions

The JSON body of the request.

bodyOptional

Request body objects

The AccessorPermissions object

An accessor identity and it's associated permissions.

ElementTypeDescriptionRequired
accessorIdentity

An Identity describing either a user, a group, or the all-users group (applying to all users).

Required
permissionsstring[]

r = read, w = write

The element can hold these values
  • r
  • w
Required

The Identity object

An Identity describing either a user, a group, or the all-users group (applying to all users).

ElementTypeDescriptionRequired
idstring

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

Optional
typestring

The type of the identity.

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

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": {
    "id": "string",
    "type": "user"
  },
  "permissions": [
    "r"
  ]
}

Response

Response codes

CodeTypeDescription
201AccessorPermissions

Created

400ErrorEnvelope

If accessor id already exists.

403ErrorEnvelope

Failed. Forbidden.

404ErrorEnvelope

No object available for the given objectId.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The AccessorPermissions object

An accessor identity and it's associated permissions.

ElementTypeDescription
accessorIdentity

An Identity describing either a user, a group, or the all-users group (applying to all users).

permissionsstring[]

r = read, w = write

The element can hold these values
  • r
  • w

The Identity object

An Identity describing either a user, a group, or the all-users group (applying to all users).

ElementTypeDescription
idstring

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

typestring

The type of the identity.

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

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "accessor": {
    "id": "string",
    "type": "user"
  },
  "permissions": [
    "r"
  ]
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}