Permissions

Update asset permissions

Replaces all permissions for a specific asset. If the asset is currently inheriting permissions, inheritance will be automatically broken. Only admin users can access this endpoint. Use cascade=true to trigger an async job that removes individual permissions from descendant assets.

put/api/v1/permissions/{assetId}

Path parameters

assetIdstring required

Asset identifier (inode or identifier)

Query parameters

cascadeboolean

If true, triggers async job to cascade permissions to descendants

Request body

Example request

{
  "permissions": [
    {
      "roleId": "abc-123-def-456",
      "individual": [
        "READ",
        "WRITE",
        "PUBLISH"
      ],
      "inheritable": {
        "FOLDER": [
          "READ",
          "CAN_ADD_CHILDREN"
        ],
        "CONTENT": [
          "READ",
          "WRITE"
        ]
      }
    }
  ]
}

Response

Permissions updated successfully

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "message": "Permissions saved successfully",
    "permissionCount": 5,
    "inheritanceBroken": true,
    "asset": {
      "assetId": "48190c8c-42c4-46af-8d1a-0cd5db894797",
      "assetType": "FOLDER",
      "inheritanceMode": "INDIVIDUAL",
      "canEditPermissions": true,
      "canEdit": true,
      "parentAssetId": "abc-123-def-456",
      "permissions": [
        {
          "roleId": "abc-123-def-456",
          "roleName": "CMS Administrator",
          "individual": [
            "READ",
            "WRITE",
            "PUBLISH"
          ],
          "inheritable": {
            "FOLDER": [
              "READ",
              "WRITE"
            ],
            "CONTENT": [
              "READ"
            ]
          }
        }
      ],
      "isParentPermissionable": true
    },
    "cascadeWarnings": [
      "Failed to trigger cascade for role xyz123: Connection timeout"
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.