Versions Compared

Old Version 6

changes.mady.by.user Unknown User (escowles@ucsd.edu)

Saved on

compared with

New Version Current

changes.mady.by.user Andrew Woods

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Excerpt

 

Request URI: /path/to/some/resource/fcr:accessroles

Methods: GET, POST, DELETE

Warning

Arbitrary access roles may be set through this API. However, they are only enforced when paired with a Policy Enforcement Point that is aware of access roles.

Status
titleGET
 Get a list of all the roles assigned to principals on this resource

Output formats: application/json

Query Parameters:

Status
subtletrue
titleeffective
  When supplied, gets the list of effective roles for this resource, including those inherited from the parent

Example:

Code Block
curl "http://localhost:8080/rest/49/3d/24/41/493d2441-0541-41c7-a23b-09d1f17d4a0f/fcr:accessroles"

Response:

Code Block
Status: 200 OK

Headers:
Content-Type: application/json
Transfer-Encoding: chunked
Server: Jetty(8.1.11.v20130520)

Body:

{"principal name 3":["admin"],"principal name 1":["reader"],"principal name 2":["writer"]}

Status:

Status
subtletrue
colourGreen
title200
 OK: if access roles retrieved successfully

Status
subtletrue
colourGreen
title204
No Content: if access roles not assigned

Status
subtletrue
colourRed
title404
Not Found: if the resource doesn't exist

 

Status
colourBlue
titlePOST
Set the roles assigned on this resource

Request Headers:

Status
subtletrue
titleContent-Type
  application/json

Example:

Code Block
curl -X POST -H "Content-Type: application/json" --data-binary "@post.txt" "http://localhost:8080/rest/49/3d/24/41/493d2441-0541-41c7-a23b-09d1f17d4a0f/fcr:accessroles"

Body:
{
   "principal name 1" : [ "reader" ],
   "principal name 2" : [ "writer" ],
   "principal name 3" : [ "admin" ]
}

Response:

Code Block
Status: 201 Created

Headers:

Location: http://localhost:8080/rest/49/3d/24/41/493d2441-0541-41c7-a23b-09d1f17d4a0f/fcr:accessroles
Content-Length: 0
Server: Jetty(8.1.11.v20130520)

Status:

Status
subtletrue
colourGreen
title201
Created: if the access roles were created successfully

Status
subtletrue
colourRed
title400
Bad Request: if there was an error processing the access roles declaration

Status
subtletrue
colourRed
title415
Unsupported Media Type: if the Content-Type of the uploaded content isn't application/json

...

Status
colourRed
titleDELETE
 Clear all roles assignments from this resource

Example:

Code Block
curl -X DELETE "http://localhost:8080/rest/49/3d/24/41/493d2441-0541-41c7-a23b-09d1f17d4a0f/fcr:accessroles"

Response:

Code Block
Status: 204 No Content

Headers: 
Server: Jetty(8.1.11.v20130520)

Status:

Status
subtletrue
colourGreen
title204
No Content: if the access roles are deleted successfully

Status
subtletrue
colourRed
title404
Not Found: if the resource doesn't exist