Opencast

ACL Manager REST Documentation

/acl-manager
This service creates, edits, retrieves and helps managing access policies (ACL templates).

Table of Contents

Read methods

Method / Path: GET /acl/{aclId}
Description: Return the ACL by the given id
Path params: aclId(Default value=0): The ACL identifier
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, The ACL has successfully been returned
404: Not Found, The ACL has not been found
500: Internal Server Error, Error during returning the ACL
Notes:
  • Return value description: Return the ACL by the given id
Testing:
Sample: /acl/{aclId}
Testing form (click to reveal)
Method / Path: GET /acl/acls.json
Description: Lists the ACL's as JSON
Path params: NONE
Optional (query) params: NONE
Response formats: application/json
Status codes: 200: OK, The list of ACL's has successfully been returned
500: Internal Server Error, Error during returning the list of ACL's
Notes:
  • Return value description: The list of ACL's as JSON
Testing:
Sample: /acl/acls.json
/acl-manager/acl/acls.json

Write methods

Method / Path: POST /apply/episode/{episodeId}
Description: Immediate application of an ACL to an episode (Attention: This endpoint is deprecated and will be removed in future versions!)
Path params: episodeId: The episode ID
Optional (form) params: aclId(Default value=0): The ID of the ACL to apply. If missing the episode ACL will be deleted to fall back to the series ACL
Status codes: 200: OK, The ACL has been successfully applied
404: Not Found, The ACL or the episode has not been found
500: Internal Server Error, Internal error
Notes:
  • Return value description: Status code
Testing:
Sample: /apply/episode/{episodeId}
Testing form (click to reveal)
Method / Path: POST /acl
Description: Create an ACL
Path params: NONE
Required (form) params: name: The ACL name
acl: The access control list
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, The ACL has successfully been added
409: Conflict, An ACL with the same name already exists
400: Bad Request, Unable to parse the ACL
500: Internal Server Error, Error during adding the ACL
Notes:
  • Return value description: Create an ACL
Testing:
Sample: /acl
Testing form (click to reveal)
Method / Path: DELETE /acl/{aclId}
Description: Delete an ACL
Path params: aclId(Default value=0): The ACL identifier
Optional (query) params: NONE
Status codes: 200: OK, The ACL has successfully been deleted
404: Not Found, The ACL has not been found
409: Conflict, The ACL could not be deleted, there are still references on it
500: Internal Server Error, Error during deleting the ACL
Notes:
  • Return value description: Delete an ACL
Testing:
Sample: /acl/{aclId}
Testing form (click to reveal)
Method / Path: POST /acl/extend
Description: Return the given ACL with a new role and action in JSON format
Path params: NONE
Required (form) params: acl: The access control list
action: The action for the ACL
role: The role for the ACL
allow: The allow status for the ACL
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, The ACL has successfully been returned
400: Bad Request, The ACL, action or role was invalid or empty
500: Internal Server Error, Error during returning the ACL
Notes:
  • Return value description: Return the ACL with the new role and action in JSON format
Testing:
Sample: /acl/extend
Testing form (click to reveal)
Method / Path: POST /acl/reduce
Description: Return the given ACL without a role and action in JSON format
Path params: NONE
Required (form) params: acl: The access control list
action: The action for the ACL
role: The role for the ACL
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, The ACL has successfully been returned
400: Bad Request, The ACL, role or action was invalid or empty
500: Internal Server Error, Error during returning the ACL
Notes:
  • Return value description: Return the ACL without the role and action in JSON format
Testing:
Sample: /acl/reduce
Testing form (click to reveal)
Method / Path: PUT /acl/{aclId}
Description: Update an ACL
Path params: aclId(Default value=0): The ACL identifier
Required (form) params: name: The ACL name
acl: The access control list
Optional (form) params: NONE
Response formats: application/json
Status codes: 200: OK, The ACL has successfully been updated
404: Not Found, The ACL has not been found
400: Bad Request, Unable to parse the ACL
500: Internal Server Error, Error during updating the ACL
Notes:
  • Return value description: Update an ACL
Testing:
Sample: /acl/{aclId}
Testing form (click to reveal)