Users

This schema extension contains models for account management.

Details

• Dependencies:
  • base

Nodes

Group

• Label: User Groups
• Description: User Group
• Namespace: User
• Icon: iconoir:group
• Human Friendly ID: name__value

Attributes

name	description	kind	optional	default_value	choices
name		Text	False
description		Text	True
idle_timeout		Number	False
permissions		Dropdown	False		admin, operator, read_only

Account

• Label: User Account
• Description: User login and authentication
• Namespace: User
• Icon: mdi:account-key
• Human Friendly ID: name__value

Attributes

name	description	kind	optional	default_value	choices
name	The login username	Text	False
full_name	Full name of the account	Text	True
ssh_key	SSH key for secure access	Password	True
password	Password for login (alternative to SSH key)	Password	True
mfa_enabled	Whether multi-factor authentication is enabled	Boolean	False	False

Relationships

name	peer	optional	cardinality	kind
user_group	UserGroup	False	one	Attribute
organization	OrganizationGeneric	False	one	Parent

Extensions

note

In this context "extensions" refer to modifications or additions to the existing schema, such as adding new attributes, relationships, or other schema elements.

OrganizationGeneric

Relationships

name	peer	optional	cardinality	kind
accounts	UserAccount	True	many	Component

Code

version: '1.0'
nodes:
- name: Group
  namespace: User
  description: User Group
  label: User Groups
  icon: iconoir:group
  include_in_menu: true
  human_friendly_id:
  - name__value
  order_by:
  - name__value
  display_label: name__value
  attributes:
  - name: name
    kind: Text
    unique: true
    optional: false
    order_weight: 1000
  - name: description
    kind: Text
    optional: true
    order_weight: 1100
  - name: idle_timeout
    kind: Number
    label: Idle Timeout (s)
    optional: false
    order_weight: 1300
  - name: permissions
    kind: Dropdown
    choices:
    - name: admin
      label: Admin
      description: All rights on device.
      color: '#E6E6FA'
    - name: operator
      label: Operator
      description: Operator right on configuration.
      color: '#E6E6FA'
    - name: read_only
      label: Read Only
      description: Read only right on configuration.
      color: '#E6E6FA'
    optional: false
    order_weight: 1200
- name: Account
  namespace: User
  description: User login and authentication
  label: User Account
  icon: mdi:account-key
  include_in_menu: true
  human_friendly_id:
  - name__value
  order_by:
  - name__value
  display_label: name__value
  attributes:
  - name: name
    kind: Text
    label: Username
    unique: true
    optional: false
    description: The login username
    order_weight: 1000
  - name: full_name
    kind: Text
    optional: true
    description: Full name of the account
    order_weight: 1100
  - name: ssh_key
    kind: Password
    optional: true
    description: SSH key for secure access
    order_weight: 1300
  - name: password
    kind: Password
    optional: true
    description: Password for login (alternative to SSH key)
    order_weight: 1400
  - name: mfa_enabled
    kind: Boolean
    default_value: false
    optional: false
    description: Whether multi-factor authentication is enabled
    order_weight: 1500
  relationships:
  - name: user_group
    peer: UserGroup
    kind: Attribute
    cardinality: one
    optional: false
    order_weight: 1200
  - name: organization
    peer: OrganizationGeneric
    kind: Parent
    cardinality: one
    optional: false
    order_weight: 900
extensions:
  nodes:
  - kind: OrganizationGeneric
    relationships:
    - name: accounts
      peer: UserAccount
      kind: Component
      cardinality: many
      optional: true
      description: List of Accounts under this organization
      order_weight: 1600