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

Sent on group changes.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionADDED">
    <div class="card">
    <div class="card-header" id="headingADDED">
    <h2 class="mb-0">
    <button aria-controls="ADDED" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED" data-toggle="collapse" onclick="setAnchor('#ADDED')" type="button"><span class="property-name">ADDED</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED" class="collapse property-definition-div" data-parent="#accordionADDED" id="ADDED">
    <div class="card-body pl-5">
    <h4>GroupAddedEvent</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="accordionADDED_id">
    <div class="card">
    <div class="card-header" id="headingADDED_id">
    <h2 class="mb-0">
    <button aria-controls="ADDED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_id" data-toggle="collapse" onclick="setAnchor('#ADDED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_id" class="collapse property-definition-div" data-parent="#accordionADDED_id" id="ADDED_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="accordionADDED_fields">
    <div class="card">
    <div class="card-header" id="headingADDED_fields">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields" data-toggle="collapse" onclick="setAnchor('#ADDED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields" class="collapse property-definition-div" data-parent="#accordionADDED_fields" id="ADDED_fields">
    <div class="card-body pl-5">
    <h4>GroupEntry</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="accordionADDED_fields_id">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_id">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_id" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_id" class="collapse property-definition-div" data-parent="#accordionADDED_fields_id" id="ADDED_fields_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>This is the API identifier for the group. Use this ID for <code>group.update</code> and <code>group.delete</code> API calls. This ID also appears in the <code>groups</code> array for each user entry in <code>user.query</code> results.</p>
    <p>NOTE: For groups from a directory service, the <code>id</code> is calculated by adding 100000000 to the <code>gid</code>. This ensures consistent API results. You cannot change directory service accounts through TrueNAS.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_gid">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_gid">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_gid" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_gid')" type="button"><span class="property-name">gid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_gid" class="collapse property-definition-div" data-parent="#accordionADDED_fields_gid" id="ADDED_fields_gid">
    <div class="card-body pl-5">
    <h4>Gid</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>A non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_name">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_name">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_name" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_name" class="collapse property-definition-div" data-parent="#accordionADDED_fields_name" id="ADDED_fields_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>A string used to identify a group.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="ADDED_fields_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_builtin">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_builtin">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_builtin" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_builtin" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_builtin')" type="button"><span class="property-name">builtin</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_builtin" class="collapse property-definition-div" data-parent="#accordionADDED_fields_builtin" id="ADDED_fields_builtin">
    <div class="card-body pl-5">
    <h4>Builtin</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If <code>True</code>, the group is an internal system account for the TrueNAS server. Typically, one should create dedicated groups for access to the TrueNAS server webui and shares.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_sudo_commands">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_sudo_commands">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_sudo_commands" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_sudo_commands" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_sudo_commands')" type="button"><span class="property-name">sudo_commands</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_sudo_commands" class="collapse property-definition-div" data-parent="#accordionADDED_fields_sudo_commands" id="ADDED_fields_sudo_commands">
    <div class="card-body pl-5">
    <h4>Sudo Commands</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>A list of commands that group members may execute with elevated privileges. User is prompted for password when executing any command from the 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="ADDED_fields_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="ADDED_fields_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="accordionADDED_fields_sudo_commands_nopasswd">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_sudo_commands_nopasswd">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_sudo_commands_nopasswd" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_sudo_commands_nopasswd" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_sudo_commands_nopasswd')" type="button"><span class="property-name">sudo_commands_nopasswd</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_sudo_commands_nopasswd" class="collapse property-definition-div" data-parent="#accordionADDED_fields_sudo_commands_nopasswd" id="ADDED_fields_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> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>A list of commands that group members may execute with elevated privileges. User is not prompted for password when executing any command from the 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="ADDED_fields_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="ADDED_fields_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="accordionADDED_fields_smb">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_smb">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_smb" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_smb" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_smb')" type="button"><span class="property-name">smb</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_smb" class="collapse property-definition-div" data-parent="#accordionADDED_fields_smb" id="ADDED_fields_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/>
    <span class="description"><p>If set to <code>True</code>, the group can be used for SMB share ACL entries. The group is mapped to an NT group account on the TrueNAS SMB server and has a <code>sid</code> value.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_userns_idmap">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_userns_idmap">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_userns_idmap" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_userns_idmap" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_userns_idmap')" type="button"><span class="property-name">userns_idmap</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_userns_idmap" class="collapse property-definition-div" data-parent="#accordionADDED_fields_userns_idmap" id="ADDED_fields_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 subgid mapping for this group. If DIRECT then the GID will be directly mapped to all containers. Alternatively, the target GID may be explicitly specified. If null, then the GID will not be mapped.</p>
    <p><strong>NOTE: This field will be ignored for groups that have been assigned TrueNAS roles.</strong></p>
    </span><div class="any-of-value" id="ADDED_fields_userns_idmap_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsADDED_fields_userns_idmap_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_ADDED_fields_userns_idmap_anyOf_i0" id="ADDED_fields_userns_idmap_anyOf_i0" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_userns_idmap_anyOf_i1" id="ADDED_fields_userns_idmap_anyOf_i1" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_userns_idmap_anyOf_i2" id="ADDED_fields_userns_idmap_anyOf_i2" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_userns_idmap_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="ADDED_fields_userns_idmap_anyOf_i0_const">Specific value: <code>"DIRECT"</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_ADDED_fields_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="ADDED_fields_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_ADDED_fields_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="accordionADDED_fields_group">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_group">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_group" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_group" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_group')" type="button"><span class="property-name">group</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_group" class="collapse property-definition-div" data-parent="#accordionADDED_fields_group" id="ADDED_fields_group">
    <div class="card-body pl-5">
    <h4>Group</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>A string used to identify a group. Identical to the <code>name</code> key.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="ADDED_fields_group_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_local">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_local">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_local" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_local" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_local')" type="button"><span class="property-name">local</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_local" class="collapse property-definition-div" data-parent="#accordionADDED_fields_local" id="ADDED_fields_local">
    <div class="card-body pl-5">
    <h4>Local</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If <code>True</code>, the group is local to the TrueNAS server. If <code>False</code>, the group is provided by a directory service.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_sid">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_sid">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_sid" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_sid')" type="button"><span class="property-name">sid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_sid" class="collapse property-definition-div" data-parent="#accordionADDED_fields_sid" id="ADDED_fields_sid">
    <div class="card-body pl-5">
    <h4>Sid</h4><br/>
    <span class="description"><p>The Security Identifier (SID) of the user if the account an <code>smb</code> account. The SMB server uses this value to check share access and for other purposes.</p>
    </span><div class="any-of-value" id="ADDED_fields_sid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsADDED_fields_sid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_ADDED_fields_sid_anyOf_i0" id="ADDED_fields_sid_anyOf_i0" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_sid_anyOf_i1" id="ADDED_fields_sid_anyOf_i1" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_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_ADDED_fields_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="accordionADDED_fields_roles">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_roles">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_roles" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_roles" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_roles')" type="button"><span class="property-name">roles</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_roles" class="collapse property-definition-div" data-parent="#accordionADDED_fields_roles" id="ADDED_fields_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="description"><p>List of roles assigned to this groups. Roles control administrative access to TrueNAS through the web UI and API. You can change group roles by using <code>privilege.create</code>, <code>privilege.update</code>, and <code>privilege.delete</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="ADDED_fields_roles_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_users">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_users">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_users" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_users" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_users')" type="button"><span class="property-name">users</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_users" class="collapse property-definition-div" data-parent="#accordionADDED_fields_users" id="ADDED_fields_users">
    <div class="card-body pl-5">
    <h4>Users</h4><span class="badge badge-dark value-type">Type: array of integer</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>A list a API user identifiers for local users who are members of this group. These IDs match the <code>id</code> field from <code>user.query</code>.</p>
    <p>NOTE: This field is empty for groups that come from directory services (<code>local</code> is <code>False</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="ADDED_fields_users_items">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_immutable">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_immutable">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_immutable" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_immutable" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_immutable')" type="button"><span class="property-name">immutable</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_immutable" class="collapse property-definition-div" data-parent="#accordionADDED_fields_immutable" id="ADDED_fields_immutable">
    <div class="card-body pl-5">
    <h4>Immutable</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>This is a read-only field showing if the group entry can be changed. If <code>True</code>, the group is immutable and cannot be changed. If <code>False</code>, the group can be changed.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED">
    <div class="card">
    <div class="card-header" id="headingCHANGED">
    <h2 class="mb-0">
    <button aria-controls="CHANGED" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED" data-toggle="collapse" onclick="setAnchor('#CHANGED')" type="button"><span class="property-name">CHANGED</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED" class="collapse property-definition-div" data-parent="#accordionCHANGED" id="CHANGED">
    <div class="card-body pl-5">
    <h4>GroupChangedEvent</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="accordionCHANGED_id">
    <div class="card">
    <div class="card-header" id="headingCHANGED_id">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_id" data-toggle="collapse" onclick="setAnchor('#CHANGED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_id" class="collapse property-definition-div" data-parent="#accordionCHANGED_id" id="CHANGED_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="accordionCHANGED_fields">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields" id="CHANGED_fields">
    <div class="card-body pl-5">
    <h4>GroupEntry</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="accordionCHANGED_fields_id">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_id">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_id" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_id" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_id" id="CHANGED_fields_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>This is the API identifier for the group. Use this ID for <code>group.update</code> and <code>group.delete</code> API calls. This ID also appears in the <code>groups</code> array for each user entry in <code>user.query</code> results.</p>
    <p>NOTE: For groups from a directory service, the <code>id</code> is calculated by adding 100000000 to the <code>gid</code>. This ensures consistent API results. You cannot change directory service accounts through TrueNAS.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_gid">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_gid">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_gid" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_gid" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_gid')" type="button"><span class="property-name">gid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_gid" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_gid" id="CHANGED_fields_gid">
    <div class="card-body pl-5">
    <h4>Gid</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>A non-negative integer used to identify a group. TrueNAS uses this value for permission checks and many other system purposes.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_name">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_name">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_name" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_name" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_name" id="CHANGED_fields_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>A string used to identify a group.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="CHANGED_fields_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_builtin">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_builtin">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_builtin" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_builtin" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_builtin')" type="button"><span class="property-name">builtin</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_builtin" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_builtin" id="CHANGED_fields_builtin">
    <div class="card-body pl-5">
    <h4>Builtin</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If <code>True</code>, the group is an internal system account for the TrueNAS server. Typically, one should create dedicated groups for access to the TrueNAS server webui and shares.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_sudo_commands">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_sudo_commands">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_sudo_commands" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_sudo_commands" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_sudo_commands')" type="button"><span class="property-name">sudo_commands</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_sudo_commands" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_sudo_commands" id="CHANGED_fields_sudo_commands">
    <div class="card-body pl-5">
    <h4>Sudo Commands</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>A list of commands that group members may execute with elevated privileges. User is prompted for password when executing any command from the 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="CHANGED_fields_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="CHANGED_fields_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="accordionCHANGED_fields_sudo_commands_nopasswd">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_sudo_commands_nopasswd">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_sudo_commands_nopasswd" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_sudo_commands_nopasswd" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_sudo_commands_nopasswd')" type="button"><span class="property-name">sudo_commands_nopasswd</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_sudo_commands_nopasswd" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_sudo_commands_nopasswd" id="CHANGED_fields_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> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>A list of commands that group members may execute with elevated privileges. User is not prompted for password when executing any command from the 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="CHANGED_fields_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="CHANGED_fields_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="accordionCHANGED_fields_smb">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_smb">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_smb" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_smb" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_smb')" type="button"><span class="property-name">smb</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_smb" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_smb" id="CHANGED_fields_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/>
    <span class="description"><p>If set to <code>True</code>, the group can be used for SMB share ACL entries. The group is mapped to an NT group account on the TrueNAS SMB server and has a <code>sid</code> value.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_userns_idmap">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_userns_idmap">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_userns_idmap" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_userns_idmap" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_userns_idmap')" type="button"><span class="property-name">userns_idmap</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_userns_idmap" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_userns_idmap" id="CHANGED_fields_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 subgid mapping for this group. If DIRECT then the GID will be directly mapped to all containers. Alternatively, the target GID may be explicitly specified. If null, then the GID will not be mapped.</p>
    <p><strong>NOTE: This field will be ignored for groups that have been assigned TrueNAS roles.</strong></p>
    </span><div class="any-of-value" id="CHANGED_fields_userns_idmap_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCHANGED_fields_userns_idmap_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_fields_userns_idmap_anyOf_i0" id="CHANGED_fields_userns_idmap_anyOf_i0" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_userns_idmap_anyOf_i1" id="CHANGED_fields_userns_idmap_anyOf_i1" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_userns_idmap_anyOf_i2" id="CHANGED_fields_userns_idmap_anyOf_i2" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_userns_idmap_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="CHANGED_fields_userns_idmap_anyOf_i0_const">Specific value: <code>"DIRECT"</code></span>
    </div><div class="tab-pane fade card-body" id="tab-pane_CHANGED_fields_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="CHANGED_fields_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_CHANGED_fields_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="accordionCHANGED_fields_group">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_group">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_group" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_group" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_group')" type="button"><span class="property-name">group</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_group" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_group" id="CHANGED_fields_group">
    <div class="card-body pl-5">
    <h4>Group</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>A string used to identify a group. Identical to the <code>name</code> key.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="CHANGED_fields_group_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_local">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_local">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_local" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_local" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_local')" type="button"><span class="property-name">local</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_local" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_local" id="CHANGED_fields_local">
    <div class="card-body pl-5">
    <h4>Local</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If <code>True</code>, the group is local to the TrueNAS server. If <code>False</code>, the group is provided by a directory service.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_sid">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_sid">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_sid" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_sid')" type="button"><span class="property-name">sid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_sid" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_sid" id="CHANGED_fields_sid">
    <div class="card-body pl-5">
    <h4>Sid</h4><br/>
    <span class="description"><p>The Security Identifier (SID) of the user if the account an <code>smb</code> account. The SMB server uses this value to check share access and for other purposes.</p>
    </span><div class="any-of-value" id="CHANGED_fields_sid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCHANGED_fields_sid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_fields_sid_anyOf_i0" id="CHANGED_fields_sid_anyOf_i0" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_sid_anyOf_i1" id="CHANGED_fields_sid_anyOf_i1" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_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_CHANGED_fields_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="accordionCHANGED_fields_roles">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_roles">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_roles" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_roles" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_roles')" type="button"><span class="property-name">roles</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_roles" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_roles" id="CHANGED_fields_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="description"><p>List of roles assigned to this groups. Roles control administrative access to TrueNAS through the web UI and API. You can change group roles by using <code>privilege.create</code>, <code>privilege.update</code>, and <code>privilege.delete</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="CHANGED_fields_roles_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_users">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_users">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_users" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_users" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_users')" type="button"><span class="property-name">users</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_users" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_users" id="CHANGED_fields_users">
    <div class="card-body pl-5">
    <h4>Users</h4><span class="badge badge-dark value-type">Type: array of integer</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>A list a API user identifiers for local users who are members of this group. These IDs match the <code>id</code> field from <code>user.query</code>.</p>
    <p>NOTE: This field is empty for groups that come from directory services (<code>local</code> is <code>False</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="CHANGED_fields_users_items">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_immutable">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_immutable">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_immutable" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_immutable" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_immutable')" type="button"><span class="property-name">immutable</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_immutable" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_immutable" id="CHANGED_fields_immutable">
    <div class="card-body pl-5">
    <h4>Immutable</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>This is a read-only field showing if the group entry can be changed. If <code>True</code>, the group is immutable and cannot be changed. If <code>False</code>, the group can be changed.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionREMOVED">
    <div class="card">
    <div class="card-header" id="headingREMOVED">
    <h2 class="mb-0">
    <button aria-controls="REMOVED" aria-expanded="" class="btn btn-link property-name-button" data-target="#REMOVED" data-toggle="collapse" onclick="setAnchor('#REMOVED')" type="button"><span class="property-name">REMOVED</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingREMOVED" class="collapse property-definition-div" data-parent="#accordionREMOVED" id="REMOVED">
    <div class="card-body pl-5">
    <h4>GroupRemovedEvent</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="accordionREMOVED_id">
    <div class="card">
    <div class="card-header" id="headingREMOVED_id">
    <h2 class="mb-0">
    <button aria-controls="REMOVED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#REMOVED_id" data-toggle="collapse" onclick="setAnchor('#REMOVED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingREMOVED_id" class="collapse property-definition-div" data-parent="#accordionREMOVED_id" id="REMOVED_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>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* ACCOUNT_READ

