Managing permissions (jackrabbit.accessmanager)
The jackrabbit-accessmanager bundle delivers a REST interface to manipulate users permissions in the JCR. After installing the jackrabbit-accessmanager bundle the REST services are exposed under the path of the node where you will manipulate the permissions for a user with a specific selector like modifyAce, acl, eacl and deleteAce.
Privileges
| Name | Description |
|---|---|
| jcr:read | the privilege to retrieve a node and get its properties and their values |
| jcr:readAccessControl | the privilege to get the access control policy of a node |
| jcr:modifyProperties | the privilege to create, modify and remove the properties of a node |
| jcr:addChildNodes | the privilege to create child nodes of a node |
| jcr:removeChildNodes | the privilege to remove child nodes of a node |
| jcr:removeNode | the privilege to remove a node |
| jcr:write | an aggregate privilege that contains: jcr:modifyProperties jcr:addChildNodes jcr:removeNode jcr:removeChildNodes |
| jcr:modifyAccessControl | the privilege to modify the access control policies of a node |
| jcr:lockManagement | the privilege to lock and unlock a node |
| jcr:versionManagement | the privilege to perform versioning operations on a node |
| jcr:nodeTypeManagement | the privilege to add and remove mixin node types and change the primary node type of a node |
| jcr:retentionManagement | the privilege to perform retention management operations on a node |
| jcr:lifecycleManagement | the privilege to perform lifecycle operations on a node |
| jcr:all | an aggregate privilege that contains all predefined privileges |
Add or modify permissions
To modify the permissions for a node POST a request to /<path-to-the-node>.modifyAce.<html or json>. The following parameters are available:
| Name | Description |
|---|---|
| principalId | The id of the user or group to modify the access rights for |
| order | The position of the entry within the list (see below for details) |
| privilege@[privilege_name] | One param for each privilege to modify. The value must be either 'granted', 'denied' or 'none'. |
| restriction@[restriction_name] | (since 3.0.4) One param for each restriction value. The same parameter name may be used again for multi-value restrictions. The value is the target value of the restriction. |
| restriction@[restriction_name]@Delete | (since 3.0.4) One param for each restriction to delete. The parameter value is ignored and can be anything. |
The order parameter may have the following values:
| Value | Description |
|---|---|
first | Place the target entry as the first amongst its siblings |
last | Place the target entry as the last amongst its siblings |
before *xyz* | Place the target entry immediately before the sibling whose name is xyz |
after *xyz* | Place the target entry immediately after the sibling whose name is xyz |
| numeric | Place the target entry at the indicated numeric place amongst its siblings where 0 is equivalent to first and 1 means the second place |
Responses:
| Status Code | Description |
|---|---|
| 200 | Success |
| 500 | Failure, HTML (or JSON) explains failure. |
Example with curl:
curl -FprincipalId=myuser -Fprivilege@jcr:read=granted http://localhost:8080/test/node.modifyAce.html
Single value restriction example with curl:
curl -FprincipalId=myuser -Fprivilege@jcr:read=granted -Frestriction@rep:glob=child1 http://localhost:8080/test/node.modifyAce.html
Multi value restriction example with curl:
curl -FprincipalId=myuser -Fprivilege@jcr:read=granted -Frestriction@rep:itemNames=name1 -Frestriction@rep:itemNames=name2 http://localhost:8080/test/node.modifyAce.html
Remove existing restriction example with curl:
curl -FprincipalId=myuser -Frestriction@rep:glob@Delete=yes http://localhost:8080/test/node.modifyAce.html
Delete permissions
To delete permissions for a node POST a request to /<path-to-the-node>.deleteAce.<html or json>. The following parameters are available:
| Parameter Name | Required | Description |
|---|---|---|
:applyTo | yes | An array of ids of the user or group whose permissions are to be deleted. |
Responses:
| Status Code | Description |
|---|---|
| 200 | Success |
| 500 | Failure, HTML (or JSON) explains failure. |
Example with curl:
curl -F:applyTo=myuser http://localhost:8080/test/node.deleteAce.html
Get permissions
Bound Permissions
To get the permissions bound to a particular node in a json format for a node send a GET request to /<path-to-the-node>.acl.json.
Example:
http://localhost:8080/test/node.acl.json
Effective Permissions
To get the permissions which are effective for a particular node in a json format for a node send a GET request to /<path-to-the-node>.eacl.json.
Example:
http://localhost:8080/test/node.eacl.json