user.setup_local_administrator

Set up local administrator (this method does not require authentication if local administrator is not already set up).

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: username

username

Type: enum (of string)

Administrator username to configure.

Must be one of:

• "root"
• "truenas_admin"

Parameter 2: password

password

Type: string

Password for the administrator account.

Parameter 3: options

options

Type: object

Additional options for cloud or specialized administrator setup.

No Additional Properties

ec2

Default: null

Cloud platform-specific options for administrator setup. null for standard setup.

Any of

• UserSetupLocalAdministratorEC2Options
• Option 2

UserSetupLocalAdministratorEC2Options

Type: object
No Additional Properties

instance_id Required

Instance Id

Type: string

EC2 instance identifier for cloud-specific administrator setup.

Must be at least 1 characters long

Type: null

Return value

Result

Type: null

Returns null on successful administrator account setup.

Required roles: