Cybus::User
Last updated
Last updated
© Copyright 2024, Cybus GmbH
This resource creates a user and optionally assigns initial permissions. See also user management.
The permissions for this user can be specified by assigning this user to some roles (preferred) or by directly listing a set of permissions.
The identifier of the resource is also automatically taken as the username for the new user. The username must be at least 3 characters long.
Property | Type | Required |
---|---|---|
is required
type: string
; must be minimum length: 5 characters
The list of permissions for this user. It is suggested to not use this property directly, but rather defining Cybus::Role resources with the list of the actual permissions, and adding those role(s) to the roles property here.
is optional
type: object[]
; all items must be of the type: object
with following properties:
Property | Type | Required |
---|---|---|
The context in which the user permissions for the resource should be interpreted.
is required
type: enum
; the value of this property must be equal to one of the below:
mqtt
when describing permissions for MQTT topics
http
when describing permissions for REST API paths
The allowed access operation to the resource.
is required
type: enum
; the value of this property must be equal to one of the below:
read
write
readWrite
Resource path. Can be REST-ful API path or MQTT topic.
is required
type: string
The list of Cybus::Role identifiers for this user, which describe the actual permissions. This is the suggested way of specifying actual permissions.
is optional
type: string[]
All items must be of the type: string
string
Required
object[]
Optional
string[]
Optional
string
Required
string
Required
string
Required