Get content restriction status for user
GET {{baseUrl}}/api/content/:id/restriction/byOperation/:operationKey/user?key=<string>&userName=<string>&accountId=<string>
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
:
https://your-domain.atlassian.net/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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
key | string | This parameter is no longer available and will be removed from the documentation soon. | |
Use accountId instead. | |||
See the deprecation notice for details. | |||
userName | string | This parameter is no longer available and will be removed from the documentation soon. | |
Use accountId instead. | |||
See the deprecation notice for details. | |||
accountId | string | (Required) The account ID of the user to be queried for whether the content restriction applies to it. The accountId | |
uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192 . |
RESPONSES
status: OK
""