Skip to main content

User

Configuration for a specific user.

CharacteristicValue
Typeobject

Properties

name (required)

Username

CharacteristicValue
Typestring

homeDirectory (optional)

Home directory for the user.

CharacteristicValue
Typestring

password (optional)

Password configuration.

CharacteristicValue
TypePassword
LinkPassword

primaryGroup (optional)

Primary group to add the user to.

CharacteristicValue
Typestring

secondaryGroups (optional)

List of secondary groups to add the user to.

CharacteristicValue
Typearray
  • Items of the array must have the type:

    CharacteristicValue
    Typestring

sshMode (optional)

SSH configuration for the user. (IN DEVELOPMENT)

CharacteristicValue
TypeSshMode
LinkSshMode

sshPublicKeys (optional)

List of SSH keys to add to the user's authorized keys.

CharacteristicValue
Typearray
  • Items of the array must have the type:

    CharacteristicValue
    Typestring

startupCommand (optional)

Command to be executed at startup, providing a way to run custom scripts or applications on user login.

CharacteristicValue
Typestring

uid (optional)

Specifies the desired User ID. If not provided, the system will automatically assign a UID.

CharacteristicValue
Typeinteger
Formatint32