audit.export
============

Generate an audit report based on the specified `query-filters` and `query-options` for the specified `services` in the specified `export_format`.

Supported export_formats are CSV, JSON, and YAML. The endpoint returns a local filesystem path where the resulting audit report is located.

This method is a job.

.. 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: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span> <div class="json-default-value">Default:<div class="value">{
      "services": [
        "MIDDLEWARE"
      ],
      "query-filters": [],
      "query-options": {
        "force_sql_filters": false,
        "limit": 0,
        "offset": 0,
        "order_by": [],
        "select": []
      },
      "remote_controller": false,
      "export_format": "JSON"
    }</div></div><br/>
    <span class="description"><p>Audit export configuration specifying services, filters, and format.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_services">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_services">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_services" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_services" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_services')" type="button"><span class="property-name">services</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_services" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_services" id="Call_parameters_items_i0_services">
    <div class="card-body pl-5">
    <h4>Services</h4><span class="badge badge-dark value-type">Type: array of enum (of string)</span> <span class="badge badge-success default-value">Default: ["MIDDLEWARE"]</span><br/>
    <span class="description"><p>Array of services to include in the audit query.</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_services_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Call_parameters_items_i0_services_items_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"MIDDLEWARE"</li><li class="list-group-item enum-item">"SMB"</li><li class="list-group-item enum-item">"SUDO"</li><li class="list-group-item enum-item">"SYSTEM"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-filters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-filters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-filters')" type="button"><span class="property-name">query-filters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-filters" id="Call_parameters_items_i0_query-filters">
    <div class="card-body pl-5">
    <h4>Query-Filters</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>List of filters for query results. See API documentation for "Query Methods" for more guidance.</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_query-filters_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i0_query-filters_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"name"</span><span class="p">,</span>
    <span class="w">        </span><span class="s2">"="</span><span class="p">,</span>
    <span class="w">        </span><span class="s2">"bob"</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i0_query-filters_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"OR"</span><span class="p">,</span>
    <span class="w">        </span><span class="p">[</span>
    <span class="w">            </span><span class="p">[</span>
    <span class="w">                </span><span class="p">[</span>
    <span class="w">                    </span><span class="s2">"name"</span><span class="p">,</span>
    <span class="w">                    </span><span class="s2">"="</span><span class="p">,</span>
    <span class="w">                    </span><span class="s2">"bob"</span>
    <span class="w">                </span><span class="p">]</span>
    <span class="w">            </span><span class="p">],</span>
    <span class="w">            </span><span class="p">[</span>
    <span class="w">                </span><span class="p">[</span>
    <span class="w">                    </span><span class="s2">"name"</span><span class="p">,</span>
    <span class="w">                    </span><span class="s2">"="</span><span class="p">,</span>
    <span class="w">                    </span><span class="s2">"larry"</span>
    <span class="w">                </span><span class="p">]</span>
    <span class="w">            </span><span class="p">]</span>
    <span class="w">        </span><span class="p">]</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-options">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options')" type="button"><span class="property-name">query-options</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options" id="Call_parameters_items_i0_query-options">
    <div class="card-body pl-5">
    <h4>AuditExportQueryOptions</h4><span class="badge badge-dark value-type">Type: object</span> <div class="json-default-value">Default:<div class="value">{
      "order_by": [],
      "select": [],
      "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_i0_query-options_order_by">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options_order_by">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options_order_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options_order_by" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options_order_by')" type="button"><span class="property-name">order_by</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options_order_by" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options_order_by" id="Call_parameters_items_i0_query-options_order_by">
    <div class="card-body pl-5">
    <h4>Order By</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>An array of field names describing the manner in which query results should be ordered. The field names may     also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place     any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the     results list). </p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0_query-options_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_i0_query-options_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_i0_query-options_select">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options_select">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options_select" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options_select" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options_select')" type="button"><span class="property-name">select</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options_select" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options_select" id="Call_parameters_items_i0_query-options_select">
    <div class="card-body pl-5">
    <h4>Select</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>An array of field names specifying the exact fields to include in the query return. The dot character <code>.</code>     may be used to explicitly select only subkeys of the query result. </p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0_query-options_select_items">
    <br/>
    <div class="any-of-value" id="Call_parameters_items_i0_query-options_select_items_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_query-options_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_i0_query-options_select_items_anyOf_i0" id="Call_parameters_items_i0_query-options_select_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_query-options_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_i0_query-options_select_items_anyOf_i1" id="Call_parameters_items_i0_query-options_select_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_query-options_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_i0_query-options_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_i0_query-options_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_i0_query-options_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_i0_query-options_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_i0_query-options_offset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options_offset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options_offset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options_offset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options_offset')" type="button"><span class="property-name">offset</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options_offset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options_offset" id="Call_parameters_items_i0_query-options_offset">
    <div class="card-body pl-5">
    <h4>Offset</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the beginning offset of the results array. When combined with the <code>limit</code> query-option     it may be used to implement pagination of large results arrays. WARNING: some query methods provide     volatile results and the onus is on the developer to understand whether pagination is appropriate     for a particular query API method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-options_limit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options_limit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options_limit')" type="button"><span class="property-name">limit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options_limit" id="Call_parameters_items_i0_query-options_limit">
    <div class="card-body pl-5">
    <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the maximum number of results matching the specified <code>query-filters</code> to return. When     combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.</p>
    <p>WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether     pagination is appropriate for a particular query API method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_query-options_force_sql_filters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_query-options_force_sql_filters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_query-options_force_sql_filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_query-options_force_sql_filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_query-options_force_sql_filters')" type="button"><span class="property-name">force_sql_filters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_query-options_force_sql_filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_query-options_force_sql_filters" id="Call_parameters_items_i0_query-options_force_sql_filters">
    <div class="card-body pl-5">
    <h4>Force Sql Filters</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Force use of SQL for result filtering to reduce response time. May not work for all methods.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_remote_controller">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_remote_controller">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_remote_controller" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_remote_controller" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_remote_controller')" type="button"><span class="property-name">remote_controller</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_remote_controller" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_remote_controller" id="Call_parameters_items_i0_remote_controller">
    <div class="card-body pl-5">
    <h4>Remote Controller</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>HA systems may direct the query to the 'remote' controller by including 'remote_controller=True'. The default     is the 'current' controller.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_export_format">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_export_format">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_export_format" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_export_format" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_export_format')" type="button"><span class="property-name">export_format</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_export_format" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_export_format" id="Call_parameters_items_i0_export_format">
    <div class="card-body pl-5">
    <h4>Export Format</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "JSON"</span><br/>
    <span class="description"><p>Format for exporting audit data.</p>
    </span><div class="enum-value" id="Call_parameters_items_i0_export_format_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"CSV"</li><li class="list-group-item enum-item">"JSON"</li><li class="list-group-item enum-item">"YAML"</li></ul>
    </div>
    </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><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Path to the exported audit data file.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SYSTEM_AUDIT_READ

