Sign in
Role Management

Update role by id.

Changed on
put/pimcore-studio/api/role/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/role/{id}
  • Auth: none declared

Path parameters

idinteger required
Example:83

Id of the Role

Request body

namestring nullable required

Name of Folder or Role

classesobject required

Classes the user is allows to see

parentIdinteger nullable required

Parent ID

permissionsobject required

List of permissions for the user

docTypesobject required

List of document types for the role

websiteTranslationLanguagesEditobject required
websiteTranslationLanguagesViewobject required
perspectivesstring[] required

Allowed studio perspectives

Example request

{
  "name": "admin",
  "parentId": 2,
  "assetWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "dataObjectWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "documentWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "perspectives": [
    "studio_default_perspective",
    "some_otherPerspective_Id"
  ]
}

Response

Updated data.

additionalAttributesobject

AdditionalAttributes

idinteger required

ID of the User

namestring nullable required

Name of Folder or Role

classesobject required

Classes the user is allows to see

parentIdinteger nullable required

Parent ID

permissionsobject required

List of permissions for the user

docTypesobject required

List of document types for the role

websiteTranslationLanguagesEditobject required
websiteTranslationLanguagesViewobject required

Example response

{
  "name": "admin",
  "parentId": 2,
  "assetWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "dataObjectWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "documentWorkspaces": [
    {
      "cpath": "/path/to/element",
      "list": true,
      "view": true,
      "publish": true,
      "delete": true,
      "rename": true,
      "create": true,
      "settings": true,
      "versions": true,
      "properties": true
    }
  ],
  "perspectives": [
    {
      "id": "5026c239_eb75_499a_8576_841bca283350",
      "name": "Cars",
      "icon": {
        "type": "path",
        "value": "/path/to/icon"
      },
      "isWriteable": true
    }
  ]
}

Changes