user.setup_local_administrator
==============================

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

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: username</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>username</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Administrator username to configure.</p>
    </span><div class="enum-value" id="Call_parameters_items_i0_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"root"</li><li class="list-group-item enum-item">"truenas_admin"</li></ul>
    </div>
    </div>
    </div>
    <h5>Parameter 2: password</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>password</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Password for the administrator account.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 3: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i2">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Additional options for cloud or specialized administrator setup.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i2_ec2">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i2_ec2">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i2_ec2" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i2_ec2" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i2_ec2')" type="button"><span class="property-name">ec2</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i2_ec2" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i2_ec2" id="Call_parameters_items_i2_ec2">
    <div class="card-body pl-5">
    <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Cloud platform-specific options for administrator setup. <code>null</code> for standard setup.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i2_ec2_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i2_ec2_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i2_ec2_anyOf_i0" id="Call_parameters_items_i2_ec2_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i2_ec2_anyOf_i0')" role="tab">UserSetupLocalAdministratorEC2Options</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i2_ec2_anyOf_i1" id="Call_parameters_items_i2_ec2_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i2_ec2_anyOf_i1')" role="tab">Option 2</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i2_ec2_anyOf_i0" role="tabpanel">
    <h4>UserSetupLocalAdministratorEC2Options</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i2_ec2_anyOf_i0_instance_id">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i2_ec2_anyOf_i0_instance_id">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i2_ec2_anyOf_i0_instance_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i2_ec2_anyOf_i0_instance_id" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i2_ec2_anyOf_i0_instance_id')" type="button"><span class="property-name">instance_id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i2_ec2_anyOf_i0_instance_id" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i2_ec2_anyOf_i0_instance_id" id="Call_parameters_items_i2_ec2_anyOf_i0_instance_id">
    <div class="card-body pl-5">
    <h4>Instance Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>EC2 instance identifier for cloud-specific administrator setup.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i2_ec2_anyOf_i0_instance_id_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i2_ec2_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: null</span><br/>
    <span class="description"><p>Returns <code>null</code> on successful administrator account setup.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* 

