General Notes
- This service offers the default acl CRUD Operations for the admin UI.
- Important: This service is for exclusive use by the module admin-ui. Its API might change anytime without prior notice. Any dependencies other than the admin UI will be strictly ignored. DO NOT use this for integration of third-party applications.
Table of Contents
Read methods
| Method / Path: | GET /acls.json |
|---|---|
| Description: | Returns a list of acls |
| Path params: | NONE |
| Optional (query) params: |
filter:
The filter used for the query. They should be formated like that: 'filter1:value1,filter2:value2' sort: The sort order. May include any of the following: NAME. Add '_DESC' to reverse the sort order (e.g. NAME_DESC). limit(Default value=100): The maximum number of items to return per page. offset(Default value=0): The page number. |
| Response formats: | application/json |
| Status codes: | 200: OK, The list of ACL's has successfully been returned |
| Notes: |
|
| Testing: |
Sample:
/acls.json?filter={filter}&sort={sort}&limit=100&offset=0
Testing form (click to reveal)
|
| Method / Path: | GET /{id} |
|---|---|
| Description: | Return the ACL by the given id |
| Path params: | id(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 |
| Notes: |
|
| Testing: |
Sample:
/{id}
Testing form (click to reveal)
|
| Method / Path: | GET /roles.json |
|---|---|
| Description: | Returns a list of roles |
| Path params: | NONE |
| Optional (query) params: |
query:
The query. target: The target of the roles. limit(Default value=100): The maximum number of items to return per page. offset(Default value=0): The page number. |
| Response formats: | application/json |
| Status codes: | 200: OK, The list of roles. |
| Notes: |
|
| Testing: |
Sample:
/roles.json?query={query}&target={target}&limit=100&offset=0
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST / |
|---|---|
| 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 |
| Notes: |
|
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | DELETE /{id} |
|---|---|
| Description: | Delete an ACL |
| Path params: | id(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 |
| Notes: |
|
| Testing: |
Sample:
/{id}
Testing form (click to reveal)
|
| Method / Path: | PUT /{id} |
|---|---|
| Description: | Update an ACL |
| Path params: | id(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 |
| Notes: |
|
| Testing: |
Sample:
/{id}
Testing form (click to reveal)
|