user.get_instance
=================

Returns instance matching `id`. If `id` is not found, Validation error is raised.

Please see `query` method documentation for `options`.

.. 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: id</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> <h5>Parameter 2: options</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span><br/> <span class="description"><p>Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation. </p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_extra"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_extra"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_extra" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extra" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extra')" type="button"><span class="property-name">extra</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_extra" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extra" id="Call_parameters_items_i1_extra"> <div class="card-body pl-5"> <h4>Extra</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span><br/> <span class="description"><p>Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_order_by"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_order_by"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_order_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_order_by" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_order_by')" type="button"><span class="property-name">order_by</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_order_by" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_order_by" id="Call_parameters_items_i1_order_by"> <div class="card-body pl-5"> <h4>Order By</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the results list). </p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_order_by_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div><br/> <div class="badge badge-secondary">Example:</div> <br/><div class="jumbotron examples" id="Call_parameters_items_i1_order_by_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"size"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"-devname"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"nulls_first:-expiretime"</span>
    <span class="p">]</span>
    </pre></div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_select"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_select"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_select" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_select" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_select')" type="button"><span class="property-name">select</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_select" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_select" id="Call_parameters_items_i1_select"> <div class="card-body pl-5"> <h4>Select</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>An array of field names specifying the exact fields to include in the query return. The dot character <code>.</code> may be used to explicitly select only subkeys of the query result. </p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_select_items"> <br/> <div class="any-of-value" id="Call_parameters_items_i1_select_items_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_select_items_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i0" id="Call_parameters_items_i1_select_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_select_items_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i1" id="Call_parameters_items_i1_select_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_select_items_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_i1_select_items_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_select_items_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_select_items_anyOf_i1_items"> <span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div></div></div> </div> </div><br/> <div class="badge badge-secondary">Example:</div> <br/><div class="jumbotron examples" id="Call_parameters_items_i1_select_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"username"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"Authentication.status"</span>
    <span class="p">]</span>
    </pre></div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_count"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_count"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_count" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_count" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_count')" type="button"><span class="property-name">count</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_count" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_count" id="Call_parameters_items_i1_count"> <div class="card-body pl-5"> <h4>Count</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Return a numeric value representing the number of items that match the specified <code>query-filters</code>. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_get"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_get"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_get" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_get" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_get')" type="button"><span class="property-name">get</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_get" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_get" id="Call_parameters_items_i1_get"> <div class="card-body pl-5"> <h4>Get</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Return the JSON object of the first result matching the specified <code>query-filters</code>. The query fails if there specified <code>query-filters</code> return no results. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_offset"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_offset"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_offset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_offset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_offset')" type="button"><span class="property-name">offset</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_offset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_offset" id="Call_parameters_items_i1_offset"> <div class="card-body pl-5"> <h4>Offset</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/> <span class="description"><p>This specifies the beginning offset of the results array. When combined with the <code>limit</code> query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_limit"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_limit"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_limit')" type="button"><span class="property-name">limit</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_limit" id="Call_parameters_items_i1_limit"> <div class="card-body pl-5"> <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/> <span class="description"><p>This specifies the maximum number of results matching the specified <code>query-filters</code> to return. When combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.</p> <p>WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_force_sql_filters"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_force_sql_filters"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_force_sql_filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_force_sql_filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_force_sql_filters')" type="button"><span class="property-name">force_sql_filters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_force_sql_filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_force_sql_filters" id="Call_parameters_items_i1_force_sql_filters"> <div class="card-body pl-5"> <h4>Force Sql Filters</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Force use of SQL for result filtering to reduce response time. May not work for all methods.</p> </span> </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>UserEntry</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="accordionReturn_value_id"> <div class="card"> <div class="card-header" id="headingReturn_value_id"> <h2 class="mb-0"> <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_uid"> <div class="card"> <div class="card-header" id="headingReturn_value_uid"> <h2 class="mb-0"> <button aria-controls="Return_value_uid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_uid" data-toggle="collapse" onclick="setAnchor('#Return_value_uid')" type="button"><span class="property-name">uid</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_uid" class="collapse property-definition-div" data-parent="#accordionReturn_value_uid" id="Return_value_uid"> <div class="card-body pl-5"> <h4>Uid</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_username"> <div class="card"> <div class="card-header" id="headingReturn_value_username"> <h2 class="mb-0"> <button aria-controls="Return_value_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_username" data-toggle="collapse" onclick="setAnchor('#Return_value_username')" type="button"><span class="property-name">username</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_username" class="collapse property-definition-div" data-parent="#accordionReturn_value_username" id="Return_value_username"> <div class="card-body pl-5"> <h4>Username</h4><br/> <div class="any-of-value" id="Return_value_username_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_username_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_username_anyOf_i0" id="Return_value_username_anyOf_i0" onclick="setAnchor('#Return_value_username_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_username_anyOf_i1" id="Return_value_username_anyOf_i1" onclick="setAnchor('#Return_value_username_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_Return_value_username_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_username_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_username_anyOf_i1_minLength">Must be at least <code>1</code> characters long</span></p> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_unixhash"> <div class="card"> <div class="card-header" id="headingReturn_value_unixhash"> <h2 class="mb-0"> <button aria-controls="Return_value_unixhash" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_unixhash" data-toggle="collapse" onclick="setAnchor('#Return_value_unixhash')" type="button"><span class="property-name">unixhash</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_unixhash" class="collapse property-definition-div" data-parent="#accordionReturn_value_unixhash" id="Return_value_unixhash"> <div class="card-body pl-5"> <h4>Unixhash</h4><br/> <div class="any-of-value" id="Return_value_unixhash_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_unixhash_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_unixhash_anyOf_i0" id="Return_value_unixhash_anyOf_i0" onclick="setAnchor('#Return_value_unixhash_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_unixhash_anyOf_i1" id="Return_value_unixhash_anyOf_i1" onclick="setAnchor('#Return_value_unixhash_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_Return_value_unixhash_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_unixhash_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_smbhash"> <div class="card"> <div class="card-header" id="headingReturn_value_smbhash"> <h2 class="mb-0"> <button aria-controls="Return_value_smbhash" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_smbhash" data-toggle="collapse" onclick="setAnchor('#Return_value_smbhash')" type="button"><span class="property-name">smbhash</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_smbhash" class="collapse property-definition-div" data-parent="#accordionReturn_value_smbhash" id="Return_value_smbhash"> <div class="card-body pl-5"> <h4>Smbhash</h4><br/> <div class="any-of-value" id="Return_value_smbhash_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_smbhash_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_smbhash_anyOf_i0" id="Return_value_smbhash_anyOf_i0" onclick="setAnchor('#Return_value_smbhash_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_smbhash_anyOf_i1" id="Return_value_smbhash_anyOf_i1" onclick="setAnchor('#Return_value_smbhash_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_Return_value_smbhash_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_smbhash_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_home"> <div class="card"> <div class="card-header" id="headingReturn_value_home"> <h2 class="mb-0"> <button aria-controls="Return_value_home" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_home" data-toggle="collapse" onclick="setAnchor('#Return_value_home')" type="button"><span class="property-name">home</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_home" class="collapse property-definition-div" data-parent="#accordionReturn_value_home" id="Return_value_home"> <div class="card-body pl-5"> <h4>Home</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "/var/empty"</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_home_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_shell"> <div class="card"> <div class="card-header" id="headingReturn_value_shell"> <h2 class="mb-0"> <button aria-controls="Return_value_shell" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_shell" data-toggle="collapse" onclick="setAnchor('#Return_value_shell')" type="button"><span class="property-name">shell</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_shell" class="collapse property-definition-div" data-parent="#accordionReturn_value_shell" id="Return_value_shell"> <div class="card-body pl-5"> <h4>Shell</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "/usr/bin/zsh"</span><br/> <span class="description"><p>Available choices can be retrieved with <code>user.shell_choices</code>.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_shell_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_full_name"> <div class="card"> <div class="card-header" id="headingReturn_value_full_name"> <h2 class="mb-0"> <button aria-controls="Return_value_full_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_full_name" data-toggle="collapse" onclick="setAnchor('#Return_value_full_name')" type="button"><span class="property-name">full_name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_full_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_full_name" id="Return_value_full_name"> <div class="card-body pl-5"> <h4>Full Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_builtin"> <div class="card"> <div class="card-header" id="headingReturn_value_builtin"> <h2 class="mb-0"> <button aria-controls="Return_value_builtin" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_builtin" data-toggle="collapse" onclick="setAnchor('#Return_value_builtin')" type="button"><span class="property-name">builtin</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_builtin" class="collapse property-definition-div" data-parent="#accordionReturn_value_builtin" id="Return_value_builtin"> <div class="card-body pl-5"> <h4>Builtin</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_smb"> <div class="card"> <div class="card-header" id="headingReturn_value_smb"> <h2 class="mb-0"> <button aria-controls="Return_value_smb" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_smb" data-toggle="collapse" onclick="setAnchor('#Return_value_smb')" type="button"><span class="property-name">smb</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_smb" class="collapse property-definition-div" data-parent="#accordionReturn_value_smb" id="Return_value_smb"> <div class="card-body pl-5"> <h4>Smb</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_userns_idmap"> <div class="card"> <div class="card-header" id="headingReturn_value_userns_idmap"> <h2 class="mb-0"> <button aria-controls="Return_value_userns_idmap" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_userns_idmap" data-toggle="collapse" onclick="setAnchor('#Return_value_userns_idmap')" type="button"><span class="property-name">userns_idmap</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_userns_idmap" class="collapse property-definition-div" data-parent="#accordionReturn_value_userns_idmap" id="Return_value_userns_idmap"> <div class="card-body pl-5"> <h4>Userns Idmap</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Specifies the subuid mapping for this user. If DIRECT then the UID will be<br/> directly mapped to all containers. Alternatively, the target UID may be<br/> explicitly specified. If None, then the UID will not be mapped.</p> <p>NOTE: this field will be ignored for users that have been assigned<br/> TrueNAS roles.</p> </span><div class="any-of-value" id="Return_value_userns_idmap_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_userns_idmap_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_userns_idmap_anyOf_i0" id="Return_value_userns_idmap_anyOf_i0" onclick="setAnchor('#Return_value_userns_idmap_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_userns_idmap_anyOf_i1" id="Return_value_userns_idmap_anyOf_i1" onclick="setAnchor('#Return_value_userns_idmap_anyOf_i1')" role="tab">Option 2</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_userns_idmap_anyOf_i2" id="Return_value_userns_idmap_anyOf_i2" onclick="setAnchor('#Return_value_userns_idmap_anyOf_i2')" role="tab">Option 3</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_userns_idmap_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_userns_idmap_anyOf_i0_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"DIRECT"</li></ul> </div><span class="const-value" id="Return_value_userns_idmap_anyOf_i0_const">Specific value: <code>"DIRECT"</code></span> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_userns_idmap_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_userns_idmap_anyOf_i1_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>4294967294</code></span></p> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_userns_idmap_anyOf_i2" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_group"> <div class="card"> <div class="card-header" id="headingReturn_value_group"> <h2 class="mb-0"> <button aria-controls="Return_value_group" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_group" data-toggle="collapse" onclick="setAnchor('#Return_value_group')" type="button"><span class="property-name">group</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_group" class="collapse property-definition-div" data-parent="#accordionReturn_value_group" id="Return_value_group"> <div class="card-body pl-5"> <h4>Group</h4><span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_groups"> <div class="card"> <div class="card-header" id="headingReturn_value_groups"> <h2 class="mb-0"> <button aria-controls="Return_value_groups" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_groups" data-toggle="collapse" onclick="setAnchor('#Return_value_groups')" type="button"><span class="property-name">groups</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_groups" class="collapse property-definition-div" data-parent="#accordionReturn_value_groups" id="Return_value_groups"> <div class="card-body pl-5"> <h4>Groups</h4><span class="badge badge-dark value-type">Type: array of integer</span><br/> <span class="description"><p>Specifies whether the user should be allowed access to SMB shares. User will also automatically be added to<br/> the <code>builtin_users</code> group.</p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_groups_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_password_disabled"> <div class="card"> <div class="card-header" id="headingReturn_value_password_disabled"> <h2 class="mb-0"> <button aria-controls="Return_value_password_disabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_password_disabled" data-toggle="collapse" onclick="setAnchor('#Return_value_password_disabled')" type="button"><span class="property-name">password_disabled</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_password_disabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_password_disabled" id="Return_value_password_disabled"> <div class="card-body pl-5"> <h4>Password Disabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_ssh_password_enabled"> <div class="card"> <div class="card-header" id="headingReturn_value_ssh_password_enabled"> <h2 class="mb-0"> <button aria-controls="Return_value_ssh_password_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_ssh_password_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_ssh_password_enabled')" type="button"><span class="property-name">ssh_password_enabled</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_ssh_password_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_ssh_password_enabled" id="Return_value_ssh_password_enabled"> <div class="card-body pl-5"> <h4>Ssh Password Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Required if <code>password_disabled</code> is false.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_sshpubkey"> <div class="card"> <div class="card-header" id="headingReturn_value_sshpubkey"> <h2 class="mb-0"> <button aria-controls="Return_value_sshpubkey" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_sshpubkey" data-toggle="collapse" onclick="setAnchor('#Return_value_sshpubkey')" type="button"><span class="property-name">sshpubkey</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_sshpubkey" class="collapse property-definition-div" data-parent="#accordionReturn_value_sshpubkey" id="Return_value_sshpubkey"> <div class="card-body pl-5"> <h4>Sshpubkey</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Return_value_sshpubkey_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_sshpubkey_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_sshpubkey_anyOf_i0" id="Return_value_sshpubkey_anyOf_i0" onclick="setAnchor('#Return_value_sshpubkey_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_sshpubkey_anyOf_i1" id="Return_value_sshpubkey_anyOf_i1" onclick="setAnchor('#Return_value_sshpubkey_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_Return_value_sshpubkey_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_sshpubkey_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_locked"> <div class="card"> <div class="card-header" id="headingReturn_value_locked"> <h2 class="mb-0"> <button aria-controls="Return_value_locked" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_locked" data-toggle="collapse" onclick="setAnchor('#Return_value_locked')" type="button"><span class="property-name">locked</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_locked" class="collapse property-definition-div" data-parent="#accordionReturn_value_locked" id="Return_value_locked"> <div class="card-body pl-5"> <h4>Locked</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_sudo_commands"> <div class="card"> <div class="card-header" id="headingReturn_value_sudo_commands"> <h2 class="mb-0"> <button aria-controls="Return_value_sudo_commands" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_sudo_commands" data-toggle="collapse" onclick="setAnchor('#Return_value_sudo_commands')" type="button"><span class="property-name">sudo_commands</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_sudo_commands" class="collapse property-definition-div" data-parent="#accordionReturn_value_sudo_commands" id="Return_value_sudo_commands"> <div class="card-body pl-5"> <h4>Sudo Commands</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_sudo_commands_items"> <span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_sudo_commands_items_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_sudo_commands_nopasswd"> <div class="card"> <div class="card-header" id="headingReturn_value_sudo_commands_nopasswd"> <h2 class="mb-0"> <button aria-controls="Return_value_sudo_commands_nopasswd" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_sudo_commands_nopasswd" data-toggle="collapse" onclick="setAnchor('#Return_value_sudo_commands_nopasswd')" type="button"><span class="property-name">sudo_commands_nopasswd</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_sudo_commands_nopasswd" class="collapse property-definition-div" data-parent="#accordionReturn_value_sudo_commands_nopasswd" id="Return_value_sudo_commands_nopasswd"> <div class="card-body pl-5"> <h4>Sudo Commands Nopasswd</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_sudo_commands_nopasswd_items"> <span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_sudo_commands_nopasswd_items_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_email"> <div class="card"> <div class="card-header" id="headingReturn_value_email"> <h2 class="mb-0"> <button aria-controls="Return_value_email" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_email" data-toggle="collapse" onclick="setAnchor('#Return_value_email')" type="button"><span class="property-name">email</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_email" class="collapse property-definition-div" data-parent="#accordionReturn_value_email" id="Return_value_email"> <div class="card-body pl-5"> <h4>Email</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Return_value_email_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_email_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_email_anyOf_i0" id="Return_value_email_anyOf_i0" onclick="setAnchor('#Return_value_email_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_email_anyOf_i1" id="Return_value_email_anyOf_i1" onclick="setAnchor('#Return_value_email_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_Return_value_email_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: email</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_email_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_id_type_both"> <div class="card"> <div class="card-header" id="headingReturn_value_id_type_both"> <h2 class="mb-0"> <button aria-controls="Return_value_id_type_both" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id_type_both" data-toggle="collapse" onclick="setAnchor('#Return_value_id_type_both')" type="button"><span class="property-name">id_type_both</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_id_type_both" class="collapse property-definition-div" data-parent="#accordionReturn_value_id_type_both" id="Return_value_id_type_both"> <div class="card-body pl-5"> <h4>Id Type Both</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_local"> <div class="card"> <div class="card-header" id="headingReturn_value_local"> <h2 class="mb-0"> <button aria-controls="Return_value_local" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_local" data-toggle="collapse" onclick="setAnchor('#Return_value_local')" type="button"><span class="property-name">local</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_local" class="collapse property-definition-div" data-parent="#accordionReturn_value_local" id="Return_value_local"> <div class="card-body pl-5"> <h4>Local</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_immutable"> <div class="card"> <div class="card-header" id="headingReturn_value_immutable"> <h2 class="mb-0"> <button aria-controls="Return_value_immutable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_immutable" data-toggle="collapse" onclick="setAnchor('#Return_value_immutable')" type="button"><span class="property-name">immutable</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_immutable" class="collapse property-definition-div" data-parent="#accordionReturn_value_immutable" id="Return_value_immutable"> <div class="card-body pl-5"> <h4>Immutable</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_twofactor_auth_configured"> <div class="card"> <div class="card-header" id="headingReturn_value_twofactor_auth_configured"> <h2 class="mb-0"> <button aria-controls="Return_value_twofactor_auth_configured" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_twofactor_auth_configured" data-toggle="collapse" onclick="setAnchor('#Return_value_twofactor_auth_configured')" type="button"><span class="property-name">twofactor_auth_configured</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_twofactor_auth_configured" class="collapse property-definition-div" data-parent="#accordionReturn_value_twofactor_auth_configured" id="Return_value_twofactor_auth_configured"> <div class="card-body pl-5"> <h4>Twofactor Auth Configured</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_sid"> <div class="card"> <div class="card-header" id="headingReturn_value_sid"> <h2 class="mb-0"> <button aria-controls="Return_value_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_sid" data-toggle="collapse" onclick="setAnchor('#Return_value_sid')" type="button"><span class="property-name">sid</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_sid" class="collapse property-definition-div" data-parent="#accordionReturn_value_sid" id="Return_value_sid"> <div class="card-body pl-5"> <h4>Sid</h4><br/> <div class="any-of-value" id="Return_value_sid_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_sid_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_sid_anyOf_i0" id="Return_value_sid_anyOf_i0" onclick="setAnchor('#Return_value_sid_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_sid_anyOf_i1" id="Return_value_sid_anyOf_i1" onclick="setAnchor('#Return_value_sid_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_Return_value_sid_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_sid_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_roles"> <div class="card"> <div class="card-header" id="headingReturn_value_roles"> <h2 class="mb-0"> <button aria-controls="Return_value_roles" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_roles" data-toggle="collapse" onclick="setAnchor('#Return_value_roles')" type="button"><span class="property-name">roles</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_roles" class="collapse property-definition-div" data-parent="#accordionReturn_value_roles" id="Return_value_roles"> <div class="card-body pl-5"> <h4>Roles</h4><span class="badge badge-dark value-type">Type: array of string</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_roles_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_api_keys"> <div class="card"> <div class="card-header" id="headingReturn_value_api_keys"> <h2 class="mb-0"> <button aria-controls="Return_value_api_keys" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_api_keys" data-toggle="collapse" onclick="setAnchor('#Return_value_api_keys')" type="button"><span class="property-name">api_keys</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_api_keys" class="collapse property-definition-div" data-parent="#accordionReturn_value_api_keys" id="Return_value_api_keys"> <div class="card-body pl-5"> <h4>Api Keys</h4><span class="badge badge-dark value-type">Type: array of integer</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_api_keys_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* ACCOUNT_READ

