ATatlassian
Content Permissions

Add folder permissions

Changed on

Adds or replaces direct content permissions for the specified principals on a folder. Permissions for other principals are preserved; use PUT to replace all permissions at once.

A principal can hold only one read or update permission. Adding read for a principal that currently has update downgrades that principal to read; adding update upgrades them. If the same request contains both operations for a principal, update takes precedence.

Reasserting a principal's existing permission is idempotent and returns a successful response without creating a duplicate entry.

Permissions required: Permission to edit the folder or administer the space.

post/folders/{id}/permissions

Request

  • Base URL
    https://no-default/wiki/api/v2
  • URL
    https://no-default/wiki/api/v2/folders/{id}/permissions
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: write:folder:confluence

Path parameters

idinteger required

The ID of the folder.

Query parameters

allow-self-lockoutboolean

If false (default), the request is rejected when it would remove the calling user's own edit access. Set to true to allow the operation even when it locks out the caller.

Request body

Response

Returned if the permissions are successfully added.

Changes