sharing.smb.getacl
==================

Retrieve the share-level ACL for the SMB share named ``share_name``.

This is the access control list enforced by the SMB protocol on connections to the share; it is distinct from the filesystem ACL on the share ``path``. Each entry's SID is resolved to a Unix ID and name where possible. The special share name ``HOMES`` refers to the auto-generated home-directory share.

A JSON-RPC ``error`` response (code ``-32602``, *Invalid params*) is returned when the named share does not exist.

.. 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: smb_getacl</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>smb_getacl</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>SharingSMBGetaclArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_share_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_share_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_share_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_share_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_share_name')" type="button"><span class="property-name">share_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_share_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_share_name" id="Call_parameters_items_i0_share_name">
    <div class="card-body pl-5">
    <h4>Share Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the SMB share to retrieve ACL for.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_share_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </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>SMBShareAcl</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated SMB share ACL configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_share_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_name" data-toggle="collapse" onclick="setAnchor('#Return_value_share_name')" type="button"><span class="property-name">share_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_name" id="Return_value_share_name">
    <div class="card-body pl-5">
    <h4>Share Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the SMB share.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_share_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_share_acl">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl')" type="button"><span class="property-name">share_acl</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl" id="Return_value_share_acl">
    <div class="card-body pl-5">
    <h4>Share Acl</h4><span class="badge badge-dark value-type">Type: array of object</span> <div class="json-default-value">Default:<div class="value">[
      {
        "ae_perm": "FULL",
        "ae_type": "ALLOWED",
        "ae_who_sid": "S-1-1-0",
        "ae_who_id": null,
        "ae_who_str": null
      }
    ]</div></div><br/>
    <span class="description"><p>List of SMB share ACL entries.</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_share_acl_items">
    <h4>SMBShareAclEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>An SMB Share ACL Entry that grants or denies specific permissions to a principal.<br/>
    You can identify the principal by a SID (<code>ae_who_sid</code>), or Unix ID (<code>ae_who_id</code>). </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_share_acl_items_ae_perm">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_perm">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_perm" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_perm" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_perm')" type="button"><span class="property-name">ae_perm</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl_items_ae_perm" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_perm" id="Return_value_share_acl_items_ae_perm">
    <div class="card-body pl-5">
    <h4>Ae Perm</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Permissions granted or denied to the principal: <code>FULL</code> grants read, write, execute, delete, write ACL, and change owner; <code>CHANGE</code> grants read, write, execute, and delete; <code>READ</code> grants read and execute. NOTE: this may appear as CUSTOM on read if user has manually edited the share ACL through unsupported means. In this case users will be required to set it to a supported value on update.</p>
    </span><div class="enum-value" id="Return_value_share_acl_items_ae_perm_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"FULL"</li><li class="list-group-item enum-item">"CHANGE"</li><li class="list-group-item enum-item">"READ"</li><li class="list-group-item enum-item">"CUSTOM"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_share_acl_items_ae_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_type" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_type')" type="button"><span class="property-name">ae_type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl_items_ae_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_type" id="Return_value_share_acl_items_ae_type">
    <div class="card-body pl-5">
    <h4>Ae Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>The type of SMB share ACL entry. This value determines whether the permissions (ae_perm) are granted (ALLOWED) or denied (DENIED).</p>
    </span><div class="enum-value" id="Return_value_share_acl_items_ae_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"ALLOWED"</li><li class="list-group-item enum-item">"DENIED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_share_acl_items_ae_who_sid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_who_sid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_who_sid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_who_sid" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_who_sid')" type="button"><span class="property-name">ae_who_sid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl_items_ae_who_sid" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_who_sid" id="Return_value_share_acl_items_ae_who_sid">
    <div class="card-body pl-5">
    <h4>Ae Who Sid</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The SID of the principal to whom this ACL entry applies.</p>
    </span><div class="any-of-value" id="Return_value_share_acl_items_ae_who_sid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_share_acl_items_ae_who_sid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_share_acl_items_ae_who_sid_anyOf_i0" id="Return_value_share_acl_items_ae_who_sid_anyOf_i0" onclick="setAnchor('#Return_value_share_acl_items_ae_who_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_share_acl_items_ae_who_sid_anyOf_i1" id="Return_value_share_acl_items_ae_who_sid_anyOf_i1" onclick="setAnchor('#Return_value_share_acl_items_ae_who_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_share_acl_items_ae_who_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_share_acl_items_ae_who_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_share_acl_items_ae_who_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_who_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_who_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_who_id" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_who_id')" type="button"><span class="property-name">ae_who_id</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl_items_ae_who_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_who_id" id="Return_value_share_acl_items_ae_who_id">
    <div class="card-body pl-5">
    <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The Unix ID of the principal to whom this ACL entry applies.</p>
    </span><div class="any-of-value" id="Return_value_share_acl_items_ae_who_id_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_share_acl_items_ae_who_id_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_share_acl_items_ae_who_id_anyOf_i0" id="Return_value_share_acl_items_ae_who_id_anyOf_i0" onclick="setAnchor('#Return_value_share_acl_items_ae_who_id_anyOf_i0')" role="tab">SMBShareAclEntryWhoId</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_share_acl_items_ae_who_id_anyOf_i1" id="Return_value_share_acl_items_ae_who_id_anyOf_i1" onclick="setAnchor('#Return_value_share_acl_items_ae_who_id_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_share_acl_items_ae_who_id_anyOf_i0" role="tabpanel">
    <h4>SMBShareAclEntryWhoId</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_share_acl_items_ae_who_id_anyOf_i0_id_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_who_id_anyOf_i0_id_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_who_id_anyOf_i0_id_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_who_id_anyOf_i0_id_type" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_who_id_anyOf_i0_id_type')" type="button"><span class="property-name">id_type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl_items_ae_who_id_anyOf_i0_id_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_who_id_anyOf_i0_id_type" id="Return_value_share_acl_items_ae_who_id_anyOf_i0_id_type">
    <div class="card-body pl-5">
    <h4>Id Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>The type of Unix ID. If the type is <code>USER</code>, the <code>xid</code> value refers to a Unix UID. If the type is <code>GROUP</code>, the <code>xid</code> value refers to a Unix GID.</p>
    </span><div class="enum-value" id="Return_value_share_acl_items_ae_who_id_anyOf_i0_id_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"USER"</li><li class="list-group-item enum-item">"GROUP"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_share_acl_items_ae_who_id_anyOf_i0_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_who_id_anyOf_i0_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_who_id_anyOf_i0_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_who_id_anyOf_i0_id" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_who_id_anyOf_i0_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_share_acl_items_ae_who_id_anyOf_i0_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_who_id_anyOf_i0_id" id="Return_value_share_acl_items_ae_who_id_anyOf_i0_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>Unix user ID (UID) or group ID (GID) depending on the <code>id_type</code> field.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_share_acl_items_ae_who_id_anyOf_i0_id_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>2147483647</code></span></p>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_share_acl_items_ae_who_id_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_share_acl_items_ae_who_str">
    <div class="card">
    <div class="card-header" id="headingReturn_value_share_acl_items_ae_who_str">
    <h2 class="mb-0">
    <button aria-controls="Return_value_share_acl_items_ae_who_str" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_share_acl_items_ae_who_str" data-toggle="collapse" onclick="setAnchor('#Return_value_share_acl_items_ae_who_str')" type="button"><span class="property-name">ae_who_str</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_share_acl_items_ae_who_str" class="collapse property-definition-div" data-parent="#accordionReturn_value_share_acl_items_ae_who_str" id="Return_value_share_acl_items_ae_who_str">
    <div class="card-body pl-5">
    <h4>Ae Who Str</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The User or group name of the principal to whom this ACL entry applies.</p>
    </span><div class="any-of-value" id="Return_value_share_acl_items_ae_who_str_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_share_acl_items_ae_who_str_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_share_acl_items_ae_who_str_anyOf_i0" id="Return_value_share_acl_items_ae_who_str_anyOf_i0" onclick="setAnchor('#Return_value_share_acl_items_ae_who_str_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_share_acl_items_ae_who_str_anyOf_i1" id="Return_value_share_acl_items_ae_who_str_anyOf_i1" onclick="setAnchor('#Return_value_share_acl_items_ae_who_str_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_share_acl_items_ae_who_str_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_share_acl_items_ae_who_str_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_share_acl_items_ae_who_str_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SHARING_SMB_READ