Cybus::User
Last updated
Was this helpful?
Last updated
Was this helpful?
The Cybus::User resource allows you to create users and, optionally, assign initial permissions.
You can assign user permissions by assigning users to or by directly listing a set of . For better maintainability, using roles is strongly recommended when defining complex permission structures.
The is automatically used as the username for new users.
Follow these requirements when setting up usernames:
Minimum length: Three characters
Allowed characters: Usernames may contain:
ASCII letters (both lowercase and uppercase)
Numbers
Underscore (_
)
Period (.
)
Pattern: Must follow the regular expression pattern: [a-zA-Z0-9][a-zA-Z0-9_.]*
Restrictions: Hyphens (-
) are not permitted in usernames as they serve as special separators between service IDs and usernames in Connectware's Docker container resource management.
The actual username in the system will be prefixed with the individual (e.g., ServiceID.myUser
).
string
Required
object[]
Optional
string[]
Optional
Is required
Type: string
Minimum length: 5 characters
Is optional
Type: object[]
; all items must be of the type: object
with the following properties:
string
Required
string
Required
string
Required
This is 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 following:
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 following:
read
write
readWrite
This is the resource path. It can be a RESTful API path or an MQTT topic.
Is required
Type: string
Is optional
Type: string[]
All items must be of type: string
.
When referencing roles, you must use the !ref
operator to create proper references.
This is the list of permissions for this user. We recommend not using this property directly. Instead, define resources with the list of actual permissions, and add those roles to the property.
This is the list of identifiers for this user that describe the actual permissions. This is the recommended way of specifying permissions.