webshare.update
===============

Update Webshare Service Configuration.

.. 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: webshare_update</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>webshare_update</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Updated webshare configuration data.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_bindip">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_bindip">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_bindip" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_bindip" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_bindip')" type="button"><span class="property-name">bindip</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_bindip" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_bindip" id="Call_parameters_items_i0_bindip">
    <div class="card-body pl-5">
    <h4>Bindip</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>List of IP addresses used by the TrueNAS Webshare server.</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_i0_bindip_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_search">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_search">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_search" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_search" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_search')" type="button"><span class="property-name">search</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_search" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_search" id="Call_parameters_items_i0_search">
    <div class="card-body pl-5">
    <h4>Search</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Search indexing is enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_passkey">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_passkey">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_passkey" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_passkey" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_passkey')" type="button"><span class="property-name">passkey</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_passkey" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_passkey" id="Call_parameters_items_i0_passkey">
    <div class="card-body pl-5">
    <h4>Passkey</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Passkey authentication mode.</p>
    </span><div class="enum-value" id="Call_parameters_items_i0_passkey_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"ENABLED"</li><li class="list-group-item enum-item">"DISABLED"</li><li class="list-group-item enum-item">"REQUIRED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_groups">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_groups">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_groups" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_groups" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_groups')" type="button"><span class="property-name">groups</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_groups" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_groups" id="Call_parameters_items_i0_groups">
    <div class="card-body pl-5">
    <h4>Groups</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>A list of AD/LDAP group names whose members will be granted access to Webshare.</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_i0_groups_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mcp_enabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mcp_enabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mcp_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mcp_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mcp_enabled')" type="button"><span class="property-name">mcp_enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mcp_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mcp_enabled" id="Call_parameters_items_i0_mcp_enabled">
    <div class="card-body pl-5">
    <h4>Mcp Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Enable the Webshare Model Context Protocol (MCP) server, which lets users connect an AI assistant to their Webshare files.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mcp_allowed_groups">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mcp_allowed_groups">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mcp_allowed_groups" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mcp_allowed_groups" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mcp_allowed_groups')" type="button"><span class="property-name">mcp_allowed_groups</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mcp_allowed_groups" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mcp_allowed_groups" id="Call_parameters_items_i0_mcp_allowed_groups">
    <div class="card-body pl-5">
    <h4>Mcp Allowed Groups</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Groups whose members may connect an AI assistant to Webshare. Each group must also grant Webshare access: <code>truenas_webshare</code> or a group listed in <code>groups</code>. At least one group is required when <code>mcp_enabled</code> is set.</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_i0_mcp_allowed_groups_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_mcp_allowed_groups_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_mcp_allow_write">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_mcp_allow_write">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_mcp_allow_write" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_mcp_allow_write" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_mcp_allow_write')" type="button"><span class="property-name">mcp_allow_write</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_mcp_allow_write" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_mcp_allow_write" id="Call_parameters_items_i0_mcp_allow_write">
    <div class="card-body pl-5">
    <h4>Mcp Allow Write</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Allow the AI assistant to create new files and directories. It can never overwrite, delete, or rename existing files. When unset, access is read-only.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>WebshareEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated Webshare service configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Unique identifier for the Webshare service configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_bindip">
    <div class="card">
    <div class="card-header" id="headingReturn_value_bindip">
    <h2 class="mb-0">
    <button aria-controls="Return_value_bindip" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_bindip" data-toggle="collapse" onclick="setAnchor('#Return_value_bindip')" type="button"><span class="property-name">bindip</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_bindip" class="collapse property-definition-div" data-parent="#accordionReturn_value_bindip" id="Return_value_bindip">
    <div class="card-body pl-5">
    <h4>Bindip</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>List of IP addresses used by the TrueNAS Webshare server.</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_bindip_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_search">
    <div class="card">
    <div class="card-header" id="headingReturn_value_search">
    <h2 class="mb-0">
    <button aria-controls="Return_value_search" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_search" data-toggle="collapse" onclick="setAnchor('#Return_value_search')" type="button"><span class="property-name">search</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_search" class="collapse property-definition-div" data-parent="#accordionReturn_value_search" id="Return_value_search">
    <div class="card-body pl-5">
    <h4>Search</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Search indexing is enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_passkey">
    <div class="card">
    <div class="card-header" id="headingReturn_value_passkey">
    <h2 class="mb-0">
    <button aria-controls="Return_value_passkey" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_passkey" data-toggle="collapse" onclick="setAnchor('#Return_value_passkey')" type="button"><span class="property-name">passkey</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_passkey" class="collapse property-definition-div" data-parent="#accordionReturn_value_passkey" id="Return_value_passkey">
    <div class="card-body pl-5">
    <h4>Passkey</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Passkey authentication mode.</p>
    </span><div class="enum-value" id="Return_value_passkey_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"ENABLED"</li><li class="list-group-item enum-item">"DISABLED"</li><li class="list-group-item enum-item">"REQUIRED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_groups">
    <div class="card">
    <div class="card-header" id="headingReturn_value_groups">
    <h2 class="mb-0">
    <button aria-controls="Return_value_groups" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_groups" data-toggle="collapse" onclick="setAnchor('#Return_value_groups')" type="button"><span class="property-name">groups</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_groups" class="collapse property-definition-div" data-parent="#accordionReturn_value_groups" id="Return_value_groups">
    <div class="card-body pl-5">
    <h4>Groups</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>A list of AD/LDAP group names whose members will be granted access to Webshare.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_groups_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mcp_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mcp_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mcp_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mcp_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_mcp_enabled')" type="button"><span class="property-name">mcp_enabled</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mcp_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_mcp_enabled" id="Return_value_mcp_enabled">
    <div class="card-body pl-5">
    <h4>Mcp Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Enable the Webshare Model Context Protocol (MCP) server, which lets users connect an AI assistant to their Webshare files.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_mcp_allowed_groups">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mcp_allowed_groups">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mcp_allowed_groups" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mcp_allowed_groups" data-toggle="collapse" onclick="setAnchor('#Return_value_mcp_allowed_groups')" type="button"><span class="property-name">mcp_allowed_groups</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mcp_allowed_groups" class="collapse property-definition-div" data-parent="#accordionReturn_value_mcp_allowed_groups" id="Return_value_mcp_allowed_groups">
    <div class="card-body pl-5">
    <h4>Mcp Allowed Groups</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Groups whose members may connect an AI assistant to Webshare. Each group must also grant Webshare access: <code>truenas_webshare</code> or a group listed in <code>groups</code>. At least one group is required when <code>mcp_enabled</code> is set.</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_mcp_allowed_groups_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_mcp_allowed_groups_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_mcp_allow_write">
    <div class="card">
    <div class="card-header" id="headingReturn_value_mcp_allow_write">
    <h2 class="mb-0">
    <button aria-controls="Return_value_mcp_allow_write" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_mcp_allow_write" data-toggle="collapse" onclick="setAnchor('#Return_value_mcp_allow_write')" type="button"><span class="property-name">mcp_allow_write</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_mcp_allow_write" class="collapse property-definition-div" data-parent="#accordionReturn_value_mcp_allow_write" id="Return_value_mcp_allow_write">
    <div class="card-body pl-5">
    <h4>Mcp Allow Write</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Allow the AI assistant to create new files and directories. It can never overwrite, delete, or rename existing files. When unset, access is read-only.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SHARING_WEBSHARE_WRITE