Availability
This feature is available starting with v1.1.0 of the Power Scripts™ for Confluence.
Syntax
addUserToContentPermission(permissionType, pageId, userNameOrKey)
Description
Adds a single user to a content permission if the user is not already in that permission.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
permissionType | string | Yes | Permission type a user will be added to. |
pageId | number | Yes | The ID of the page to add permission to. |
| string | Yes | User name or key of a user to add in permission. |
Valid content permission types
| Permission type | Description |
|---|---|
| View | Permission to view content. |
| Edit | Permission to edit content. |
Return type
boolean (true/false)
Returns true if the content permission was actually changed by the routine invocation, that is a user was actually added to the specified content permission.
Returns false if a content permission was not changed.
If the routine returns false, it doesn't mean that a user doesn't have the specified permission. It just means that the state of the content permission was not changed. For example, if the specified user was in the specified content permission before the routine invocation, the routine will return false, because the state of the content permission was not changed. In order to check if the specified user has a certain content permission please use the following routine: userHasContentPermission.
Example
Allows the "jdoe" user to modify page with the 11508 ID.
addUserToContentPermission("Edit", 11508, "jdoe");
See also