Confluence.js - Cloud and Server API library
    Preparing search index...

    Class ContentRestrictions

    Index

    Constructors

    Methods

    • Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the admins group, the following request will return true:

      https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/group/admins

      Note that a response of true does not guarantee that the group 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.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<void>

    • Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the admins group, the following request will return true:

      https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/group/admins

      Note that a response of true does not guarantee that the group 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.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>

    • 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.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<void>

    • 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.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>

    • Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the 123456 group id, the following request will return true:

      https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456

      Note that a response of true does not guarantee that the group 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.

      Type Parameters

      • T = unknown

      Returns Promise<void>

    • Returns whether the specified content restriction applies to a group. For example, if a page with id=123 has a read restriction for the 123456 group id, the following request will return true:

      https://your-domain.atlassian.net/wiki/rest/api/content/123/restriction/byOperation/read/byGroupId/123456

      Note that a response of true does not guarantee that the group 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.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>

    • Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.

      Permissions required: Permission to edit the content.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<void>

    • Removes a group from a content restriction. That is, remove read or update permission for the group for a piece of content.

      Permissions required: Permission to edit the content.

      Type Parameters

      • T = unknown

      Parameters

      Returns Promise<T>