Function: getContentRestrictionStatusForUser()
ts
function getContentRestrictionStatusForUser(client, parameters): Promise<void>;Defined in: src/v1/api/contentRestrictions.ts:233
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.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { accountId?: string; id: string; key?: string; operationKey: string; username?: string; } | - |
parameters.accountId? | string | The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, 384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192. |
parameters.id | string | The ID of the content that the restriction applies to. |
parameters.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. |
parameters.operationKey | string | The operation that is restricted. |
parameters.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. |
Returns
Promise<void>