ACL

Routes for setting ACL. Used in Backoffice.

get
Get ACL types

https://api.appmixer.com/acl-types
There are two types of access control lists, for components and for API routes. Restricted to admin users only.
Request
Response
Request
Response
200: OK
Currently there are ACL rules for components and routes. In the future, other types might be added.
[
"routes",
"components"
]

get
Get ACL rules for components|routes

https://api.appmixer.com/acl/:type
Get list of all the ACL rules for given type. Restricted to admin users only.
Request
Response
Request
Path Parameters
type
optional
string
components | routes
Response
200: OK
This is default list of ACL rules for components. All users can access all components.
[
{
"role": "admin",
"resource": "*",
"action": [
"*"
],
"attributes": [
"non-private"
]
},
{
"role": "user",
"resource": "*",
"action": [
"*"
],
"attributes": [
"non-private"
]
},
{
"role": "tester",
"resource": "*",
"action": [
"*"
],
"attributes": [
"non-private"
]
}
]

post
Update ACL rules

https://api.appmixer.com/acl/:type
Update ACL rule set for given type. Restricted to admin users only.
Request
Response
Request
Path Parameters
type
optional
string
components | routes
Body Parameters
optional
array
Body has to be an array of ACL rules, where each rule has the following structure: { role: string - admin | user | tester ... resource: string - flows | appmixer.utils.* ... action: array of strings - * | read ... attributes: array of strings - * | non-private | ... }
Response
200: OK

get
Get available resource values

https://api.appmixer.com/acl/:type/resources
Get available values for resource property for an ACL rule. This is used for building UI in Backoffice for setting ACL rules. Restricted to admin users only.
Request
Response
Request
Path Parameters
type
optional
string
components | routes
Response
200: OK
Available options for routes type. In case of components it returns pattern that a resource has to match.
['*', 'flows']

get
Get available action values

https://api.appmixer.com/acl/:type/actions
Get available values for action property for an ACL rule. This is used for building UI in Backoffice for setting ACL rules. Restricted to admin users only.
Request
Response
Request
Path Parameters
type
optional
string
components | routes
Response
200: OK
Available options for routes type.
['*', 'read', '!read', 'create', '!create', 'update', '!update', 'delete', '!delete']

get
Get available options for attributes property.

https://api.appmixer.com/acl/:type/resource/:resource/attributes
Get available values for attributes property for an ACL rules. This is used for building UI in Backoffice for setting ACL rules. Restricted to admin users only.
Request
Response
Request
Path Parameters
type
optional
string
components | routes
resource
optional
string
resource name - flows, appmixer.utils.controls.*, ...
Response
200: OK