v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Content restrictions

Get content restriction status for user

Returns whether the specified content restriction applies to a user. For example, if a page with id=123 has a read restriction for a user with an account ID of 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192, the following request will return true:

/wiki/rest/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192

Note that a response of true does not guarantee that the user can view the page, as it does not account for account-inherited restrictions, space permissions, or even product access. For more information, see Confluence permissions.

Permissions required: Permission to view the content.

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

Path parameters

idstring required

The ID of the content that the restriction applies to.

operationKeystring required

The operation that is restricted.

Query parameters

keystring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

usernamestring

This parameter is no longer available and will be removed from the documentation soon. Use accountId instead. See the deprecation notice for details.

accountIdstring

The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192.

Response

Return true if the content restriction applies to the user. The response body will be empty.