Cybus::Role
Creates a new role resource. See also User Management.
The role defined here can be used in the list of roles for a Cybus::User resource, which is the suggested way of specifying a set of permissions for a user.
Properties
permissions
The permissions associated with this role.
Required
Type:
object[]
; all items must be of the type:object
with the following properties:
context
The context in which the role permissions for the resource should be interpreted.
Required
Type:
enum
; the value of this property must be equal to one of the following:mqtt
when describing permissions for MQTT topicshttp
when describing permissions for REST API paths
operation
The allowed access operation to the resource.
Required
Type:
enum
; the value of this property must be equal to one of the following:read
write
readWrite
resource
The resource path. Can be a REST-ful API path or an MQTT topic.
Required
Type:
string
Example
myRole:
type: Cybus::Role
properties:
permissions:
- resource: edge.cybus/#
operation: readWrite
context: mqtt
Last updated
Was this helpful?