ATatlassian
Content Permissions

Get whiteboard permissions

Changed on

Returns the direct content permissions on a whiteboard with optional filtering. Results are cursor-paginated (max 250 per page).

Permissions required: Permission to view the whiteboard.

get/whiteboards/{id}/permissions

Request

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

Path parameters

idinteger required

The ID of the whiteboard.

Query parameters

operation'read' | 'update'

Filter by operation (read or update).

principal-type'user' | 'group'

Filter by principal type (user or group). May be used without principal-id to return all permissions for that type.

principal-idstring

Filter by principal ID. Must be provided together with principal-type.

cursorstring

Opaque cursor for pagination. Use the value from the previous response's _links.next.

limitinteger

Maximum number of permission entries to return. Must be between 1 and 250.

Response

Returned if the permissions are successfully retrieved.

Changes