Private
clientAdds a group to a content restriction. That is, grant read or update permission to the group for a piece of content.
Permissions required: Permission to edit the content.
Optional
callback: undefinedAdds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a piece of content.
Permissions required: Permission to edit the content.
Adds a group to a content restriction by Group Id. That is, grant read or update permission to the group for a piece of content.
Permissions required: Permission to edit the content.
Optional
callback: undefinedAdds restrictions to a piece of content. Note, this does not change any existing restrictions on the content.
Permissions required: Permission to edit the content.
Adds restrictions to a piece of content. Note, this does not change any existing restrictions on the content.
Permissions required: Permission to edit the content.
Optional
callback: undefinedAdds a user to a content restriction. That is, grant read or update permission to the user for a piece of content.
Permissions required: Permission to edit the content.
Adds a user to a content restriction. That is, grant read or update permission to the user for a piece of content.
Permissions required: Permission to edit the content.
Optional
callback: undefinedRemoves all restrictions (read and update) on a piece of content.
Permissions required: Permission to edit the content.
Removes all restrictions (read and update) on a piece of content.
Permissions required: Permission to edit the content.
Optional
callback: undefinedReturns 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.
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.
Optional
callback: undefinedReturns 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.
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.
Optional
callback: undefinedReturns 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.
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.
Optional
callback: undefinedReturns the restrictions on a piece of content.
Permissions required: Permission to view the content.
Returns the restrictions on a piece of content.
Permissions required: Permission to view the content.
Optional
callback: undefinedReturns restrictions on a piece of content by operation. This method is similar to Get restrictions except that the operations are properties of the return object, rather than items in a results array.
Permissions required: Permission to view the content.
Returns restrictions on a piece of content by operation. This method is similar to Get restrictions except that the operations are properties of the return object, rather than items in a results array.
Permissions required: Permission to view the content.
Optional
callback: undefinedReturns the restictions on a piece of content for a given operation (read or update).
Permissions required: Permission to view the content.
Returns the restictions on a piece of content for a given operation (read or update).
Permissions required: Permission to view the content.
Optional
callback: undefinedRemoves 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.
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.
Optional
callback: undefinedRemoves 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.
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.
Optional
callback: undefinedRemoves 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.
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.
Optional
callback: undefinedUpdates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request.
Permissions required: Permission to edit the content.
Updates restrictions for a piece of content. This removes the existing restrictions and replaces them with the restrictions in the request.
Permissions required: Permission to edit the content.
Optional
callback: undefinedGenerated using TypeDoc v0.25.12
Adds a group to a content restriction. That is, grant read or update permission to the group for a piece of content.
Permissions required: Permission to edit the content.