group.query
===========

Query groups with `query-filters` and `query-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: filters</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>filters</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</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_i0_items"> <span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </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> <div class="json-default-value">Default:<div class="value">{
      "relationships": true,
      "extend": null,
      "extend_context": null,
      "prefix": null,
      "extra": {},
      "order_by": [],
      "select": [],
      "count": false,
      "get": false,
      "offset": 0,
      "limit": 0,
      "force_sql_filters": false
    }</div></div><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_relationships"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_relationships"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_relationships" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_relationships" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_relationships')" type="button"><span class="property-name">relationships</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_relationships" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_relationships" id="Call_parameters_items_i1_relationships"> <div class="card-body pl-5"> <h4>Relationships</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="accordionCall_parameters_items_i1_extend"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_extend"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_extend" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extend" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extend')" type="button"><span class="property-name">extend</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_extend" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extend" id="Call_parameters_items_i1_extend"> <div class="card-body pl-5"> <h4>Extend</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i1_extend_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_extend_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_extend_anyOf_i0" id="Call_parameters_items_i1_extend_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_extend_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_extend_anyOf_i1" id="Call_parameters_items_i1_extend_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_extend_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_extend_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_extend_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="accordionCall_parameters_items_i1_extend_context"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_extend_context"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_extend_context" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extend_context" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extend_context')" type="button"><span class="property-name">extend_context</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_extend_context" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extend_context" id="Call_parameters_items_i1_extend_context"> <div class="card-body pl-5"> <h4>Extend Context</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i1_extend_context_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_extend_context_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_extend_context_anyOf_i0" id="Call_parameters_items_i1_extend_context_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_extend_context_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_extend_context_anyOf_i1" id="Call_parameters_items_i1_extend_context_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_extend_context_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_extend_context_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_extend_context_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="accordionCall_parameters_items_i1_prefix"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_prefix"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_prefix" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_prefix" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_prefix')" type="button"><span class="property-name">prefix</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_prefix" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_prefix" id="Call_parameters_items_i1_prefix"> <div class="card-body pl-5"> <h4>Prefix</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i1_prefix_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_prefix_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_prefix_anyOf_i0" id="Call_parameters_items_i1_prefix_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_prefix_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_prefix_anyOf_i1" id="Call_parameters_items_i1_prefix_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_prefix_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_prefix_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_prefix_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="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<br/> 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<br/> also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place<br/> any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the<br/> 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><br/> 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<br/> 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<br/> it may be used to implement pagination of large results arrays. WARNING: some query methods provide<br/> volatile results and the onus is on the developer to understand whether pagination is appropriate<br/> 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<br/> combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.<br/> WARNING: some query methods provide volatile results and the onus is on the developer to understand whether<br/> 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/> </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><br/> <div class="any-of-value" id="Return_value_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0" id="Return_value_anyOf_i0" onclick="setAnchor('#Return_value_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_anyOf_i1" id="Return_value_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i1')" role="tab">GroupQueryResultItem</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i2" id="Return_value_anyOf_i2" onclick="setAnchor('#Return_value_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_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: array of object</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_anyOf_i0_items"> <h4>GroupQueryResultItem</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_anyOf_i0_items_id"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_id"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_id" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_id')" type="button"><span class="property-name">id</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_id" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_gid"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_gid"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_gid" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_gid')" type="button"><span class="property-name">gid</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_gid" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_gid" id="Return_value_anyOf_i0_items_gid"> <div class="card-body pl-5"> <h4>Gid</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_name"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_name"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_name')" type="button"><span class="property-name">name</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_name" id="Return_value_anyOf_i0_items_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i0_items_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_builtin"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_builtin"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_builtin" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_builtin" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_builtin')" type="button"><span class="property-name">builtin</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_builtin" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_builtin" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_sudo_commands"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_sudo_commands"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_sudo_commands" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_sudo_commands" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_sudo_commands')" type="button"><span class="property-name">sudo_commands</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_sudo_commands" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_sudo_commands" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_sudo_commands_nopasswd"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_sudo_commands_nopasswd"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_sudo_commands_nopasswd" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_sudo_commands_nopasswd" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_sudo_commands_nopasswd')" type="button"><span class="property-name">sudo_commands_nopasswd</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_sudo_commands_nopasswd" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_sudo_commands_nopasswd" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_smb"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_smb"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_smb" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_smb" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_smb')" type="button"><span class="property-name">smb</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_smb" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_smb" id="Return_value_anyOf_i0_items_smb"> <div class="card-body pl-5"> <h4>Smb</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Specifies whether the group should be mapped into an NT group.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_userns_idmap"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_userns_idmap"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_userns_idmap" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_userns_idmap" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_userns_idmap')" type="button"><span class="property-name">userns_idmap</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_userns_idmap" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_userns_idmap" id="Return_value_anyOf_i0_items_userns_idmap"> <div class="card-body pl-5"> <h4>Userns Idmap</h4><br/> <span class="description"><p>Species the subgid mapping for this group. If DIRECT then the GID will be<br/> directly mapped to all containers. Alternatively, the target GID may be<br/> explicitly specified. If None, then the GID will not be mapped.</p> <p>NOTE: this field will be ignored for groups that have been assigned<br/> TrueNAS roles.</p> </span><div class="any-of-value" id="Return_value_anyOf_i0_items_userns_idmap_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_items_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_anyOf_i0_items_userns_idmap_anyOf_i0" id="Return_value_anyOf_i0_items_userns_idmap_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_items_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_anyOf_i0_items_userns_idmap_anyOf_i1" id="Return_value_anyOf_i0_items_userns_idmap_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_items_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_anyOf_i0_items_userns_idmap_anyOf_i2" id="Return_value_anyOf_i0_items_userns_idmap_anyOf_i2" onclick="setAnchor('#Return_value_anyOf_i0_items_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_anyOf_i0_items_userns_idmap_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_userns_idmap_anyOf_i0_const">Specific value: <code>"DIRECT"</code></span> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_group"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_group"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_group" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_group" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_group')" type="button"><span class="property-name">group</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_group" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_group" id="Return_value_anyOf_i0_items_group"> <div class="card-body pl-5"> <h4>Group</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i0_items_group_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_id_type_both"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_id_type_both"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_id_type_both" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_id_type_both" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_id_type_both')" type="button"><span class="property-name">id_type_both</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_id_type_both" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_id_type_both" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_local"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_local"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_local" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_local" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_local')" type="button"><span class="property-name">local</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_local" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_local" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_sid"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_sid"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_sid" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_sid')" type="button"><span class="property-name">sid</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_sid" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_sid" id="Return_value_anyOf_i0_items_sid"> <div class="card-body pl-5"> <h4>Sid</h4><br/> <div class="any-of-value" id="Return_value_anyOf_i0_items_sid_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_items_sid_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_sid_anyOf_i0" id="Return_value_anyOf_i0_items_sid_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_items_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_anyOf_i0_items_sid_anyOf_i1" id="Return_value_anyOf_i0_items_sid_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_roles"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_roles"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_roles" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_roles" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_roles')" type="button"><span class="property-name">roles</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_roles" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_roles" id="Return_value_anyOf_i0_items_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_anyOf_i0_items_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_anyOf_i0_items_users"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_users"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_users" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_users" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_users')" type="button"><span class="property-name">users</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_users" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_users" id="Return_value_anyOf_i0_items_users"> <div class="card-body pl-5"> <h4>Users</h4><span class="badge badge-dark value-type">Type: array of integer</span><br/> <span class="description"><p>A list of user ids (<code>id</code> attribute from <code>user.query</code>).</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_anyOf_i0_items_users_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i1" role="tabpanel"> <h4>GroupQueryResultItem</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_anyOf_i1_id"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_id"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_id" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_id')" type="button"><span class="property-name">id</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_id" id="Return_value_anyOf_i1_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_anyOf_i1_gid"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_gid"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_gid" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_gid')" type="button"><span class="property-name">gid</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_gid" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_gid" id="Return_value_anyOf_i1_gid"> <div class="card-body pl-5"> <h4>Gid</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_name"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_name"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_name" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_name')" type="button"><span class="property-name">name</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_name" id="Return_value_anyOf_i1_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i1_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_builtin"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_builtin"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_builtin" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_builtin" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_builtin')" type="button"><span class="property-name">builtin</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_builtin" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_builtin" id="Return_value_anyOf_i1_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_anyOf_i1_sudo_commands"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_sudo_commands"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_sudo_commands" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_sudo_commands" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_sudo_commands')" type="button"><span class="property-name">sudo_commands</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_sudo_commands" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_sudo_commands" id="Return_value_anyOf_i1_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_anyOf_i1_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_anyOf_i1_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_anyOf_i1_sudo_commands_nopasswd"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_sudo_commands_nopasswd"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_sudo_commands_nopasswd" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_sudo_commands_nopasswd" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_sudo_commands_nopasswd')" type="button"><span class="property-name">sudo_commands_nopasswd</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_sudo_commands_nopasswd" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_sudo_commands_nopasswd" id="Return_value_anyOf_i1_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_anyOf_i1_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_anyOf_i1_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_anyOf_i1_smb"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_smb"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_smb" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_smb" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_smb')" type="button"><span class="property-name">smb</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_smb" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_smb" id="Return_value_anyOf_i1_smb"> <div class="card-body pl-5"> <h4>Smb</h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Specifies whether the group should be mapped into an NT group.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_userns_idmap"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_userns_idmap"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_userns_idmap" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_userns_idmap" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_userns_idmap')" type="button"><span class="property-name">userns_idmap</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_userns_idmap" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_userns_idmap" id="Return_value_anyOf_i1_userns_idmap"> <div class="card-body pl-5"> <h4>Userns Idmap</h4><br/> <span class="description"><p>Species the subgid mapping for this group. If DIRECT then the GID will be<br/> directly mapped to all containers. Alternatively, the target GID may be<br/> explicitly specified. If None, then the GID will not be mapped.</p> <p>NOTE: this field will be ignored for groups that have been assigned<br/> TrueNAS roles.</p> </span><div class="any-of-value" id="Return_value_anyOf_i1_userns_idmap_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i1_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_anyOf_i1_userns_idmap_anyOf_i0" id="Return_value_anyOf_i1_userns_idmap_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i1_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_anyOf_i1_userns_idmap_anyOf_i1" id="Return_value_anyOf_i1_userns_idmap_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i1_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_anyOf_i1_userns_idmap_anyOf_i2" id="Return_value_anyOf_i1_userns_idmap_anyOf_i2" onclick="setAnchor('#Return_value_anyOf_i1_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_anyOf_i1_userns_idmap_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: const</span><br/> <div class="enum-value" id="Return_value_anyOf_i1_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_anyOf_i1_userns_idmap_anyOf_i0_const">Specific value: <code>"DIRECT"</code></span> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i1_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_anyOf_i1_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_anyOf_i1_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_anyOf_i1_group"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_group"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_group" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_group" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_group')" type="button"><span class="property-name">group</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_group" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_group" id="Return_value_anyOf_i1_group"> <div class="card-body pl-5"> <h4>Group</h4><span class="badge badge-dark value-type">Type: string</span><br/> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i1_group_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_id_type_both"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_id_type_both"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_id_type_both" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_id_type_both" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_id_type_both')" type="button"><span class="property-name">id_type_both</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_id_type_both" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_id_type_both" id="Return_value_anyOf_i1_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_anyOf_i1_local"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_local"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_local" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_local" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_local')" type="button"><span class="property-name">local</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_local" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_local" id="Return_value_anyOf_i1_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_anyOf_i1_sid"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_sid"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_sid" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_sid')" type="button"><span class="property-name">sid</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_sid" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_sid" id="Return_value_anyOf_i1_sid"> <div class="card-body pl-5"> <h4>Sid</h4><br/> <div class="any-of-value" id="Return_value_anyOf_i1_sid_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i1_sid_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i1_sid_anyOf_i0" id="Return_value_anyOf_i1_sid_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i1_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_anyOf_i1_sid_anyOf_i1" id="Return_value_anyOf_i1_sid_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i1_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_anyOf_i1_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_anyOf_i1_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_anyOf_i1_roles"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_roles"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_roles" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_roles" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_roles')" type="button"><span class="property-name">roles</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_roles" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_roles" id="Return_value_anyOf_i1_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_anyOf_i1_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_anyOf_i1_users"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_users"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_users" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_users" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_users')" type="button"><span class="property-name">users</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_users" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_users" id="Return_value_anyOf_i1_users"> <div class="card-body pl-5"> <h4>Users</h4><span class="badge badge-dark value-type">Type: array of integer</span><br/> <span class="description"><p>A list of user ids (<code>id</code> attribute from <code>user.query</code>).</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_anyOf_i1_users_items"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i2" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div></div></div> </div> </div> </div> </div> </div><br><br>

*Required roles:* ACCOUNT_READ

