ATatlassian
Content restrictions

Get restrictions for operation

Returns the restictions on a piece of content for a given operation (read or update).

Permissions required: Permission to view the content.

get/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-content.all

Path parameters

idstring required

The ID of the content to be queried for its restrictions.

operationKey'read' | 'update' required

The operation type of the restrictions to be returned.

Query parameters

expandstring[]

A multi-value parameter indicating which properties of the content restrictions to expand.

  • restrictions.user returns the users that the restrictions apply to. Expanded by default.
  • restrictions.group returns the groups that the restrictions apply to. Expanded by default.
  • content returns the piece of content that the restrictions are applied to.
startinteger

The starting index of the users and groups in the returned restrictions.

limitinteger

The maximum number of users and the maximum number of groups, in the returned restrictions, to return per page. Note, this may be restricted by fixed system limits.

Response

Returned if the requested restrictions are returned.

operation'administer' | 'copy' | 'create' | 'delete' | 'export' | 'move' | 'purge' | 'purge_version' | 'read' | 'restore' | 'update' | 'use' required
_linksGenericLinks required

Changes

No recorded changes to this operation across all 2 revisions of this API.