keychaincredential.query
========================

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionCall_parameters"> <div class="card"> <div class="card-header" id="headingCall_parameters"> <h2 class="mb-0"> <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters"> <div class="card-body pl-5"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4> <h5>Parameter 1: filters</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>filters</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0_items"> <span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div> </div> <h5>Parameter 2: options</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <div class="json-default-value">Default:<div class="value">{
      "relationships": true,
      "extend": null,
      "extend_context": null,
      "prefix": null,
      "extra": {},
      "order_by": [],
      "select": [],
      "count": false,
      "get": false,
      "offset": 0,
      "limit": 0,
      "force_sql_filters": false
    }</div></div><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_relationships"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_relationships"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_relationships" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_relationships" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_relationships')" type="button"><span class="property-name">relationships</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_relationships" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_relationships" id="Call_parameters_items_i1_relationships"> <div class="card-body pl-5"> <h4>Relationships</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_extend"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_extend"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_extend" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extend" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extend')" type="button"><span class="property-name">extend</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_extend" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extend" id="Call_parameters_items_i1_extend"> <div class="card-body pl-5"> <h4>Extend</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i1_extend_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_extend_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_extend_anyOf_i0" id="Call_parameters_items_i1_extend_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_extend_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_extend_anyOf_i1" id="Call_parameters_items_i1_extend_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_extend_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_extend_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_extend_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_extend_context"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_extend_context"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_extend_context" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extend_context" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extend_context')" type="button"><span class="property-name">extend_context</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_extend_context" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extend_context" id="Call_parameters_items_i1_extend_context"> <div class="card-body pl-5"> <h4>Extend Context</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i1_extend_context_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_extend_context_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_extend_context_anyOf_i0" id="Call_parameters_items_i1_extend_context_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_extend_context_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_extend_context_anyOf_i1" id="Call_parameters_items_i1_extend_context_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_extend_context_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_extend_context_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_extend_context_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_prefix"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_prefix"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_prefix" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_prefix" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_prefix')" type="button"><span class="property-name">prefix</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_prefix" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_prefix" id="Call_parameters_items_i1_prefix"> <div class="card-body pl-5"> <h4>Prefix</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Call_parameters_items_i1_prefix_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_prefix_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_prefix_anyOf_i0" id="Call_parameters_items_i1_prefix_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_prefix_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_prefix_anyOf_i1" id="Call_parameters_items_i1_prefix_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_prefix_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_prefix_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_prefix_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_extra"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_extra"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_extra" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extra" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extra')" type="button"><span class="property-name">extra</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_extra" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extra" id="Call_parameters_items_i1_extra"> <div class="card-body pl-5"> <h4>Extra</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span><br/> <span class="description"><p>Extra options are defined on a per-endpoint basis and are described in the documentation for the associated<br/> query method. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_order_by"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_order_by"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_order_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_order_by" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_order_by')" type="button"><span class="property-name">order_by</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_order_by" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_order_by" id="Call_parameters_items_i1_order_by"> <div class="card-body pl-5"> <h4>Order By</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>An array of field names describing the manner in which query results should be ordered. The field names may<br/> also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place<br/> any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the<br/> results list). </p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_order_by_items"> <span class="badge badge-dark value-type">Type: string</span><br/> </div> </div><br/> <div class="badge badge-secondary">Example:</div> <br/><div class="jumbotron examples" id="Call_parameters_items_i1_order_by_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"size"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"-devname"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"nulls_first:-expiretime"</span>
    <span class="p">]</span>
    </pre></div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_select"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_select"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_select" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_select" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_select')" type="button"><span class="property-name">select</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_select" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_select" id="Call_parameters_items_i1_select"> <div class="card-body pl-5"> <h4>Select</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/> <span class="description"><p>An array of field names specifying the exact fields to include in the query return. The dot character <code>.</code><br/> may be used to explicitly select only subkeys of the query result. </p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_select_items"> <br/> <div class="any-of-value" id="Call_parameters_items_i1_select_items_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_select_items_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i0" id="Call_parameters_items_i1_select_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_select_items_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_select_items_anyOf_i1" id="Call_parameters_items_i1_select_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_select_items_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_select_items_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_select_items_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: array</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_select_items_anyOf_i1_items"> <span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div></div></div> </div> </div><br/> <div class="badge badge-secondary">Example:</div> <br/><div class="jumbotron examples" id="Call_parameters_items_i1_select_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"username"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"Authentication.status"</span>
    <span class="p">]</span>
    </pre></div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_count"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_count"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_count" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_count" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_count')" type="button"><span class="property-name">count</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_count" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_count" id="Call_parameters_items_i1_count"> <div class="card-body pl-5"> <h4>Count</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Return a numeric value representing the number of items that match the specified <code>query-filters</code>. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_get"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_get"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_get" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_get" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_get')" type="button"><span class="property-name">get</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_get" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_get" id="Call_parameters_items_i1_get"> <div class="card-body pl-5"> <h4>Get</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> <span class="description"><p>Return the JSON object of the first result matching the specified <code>query-filters</code>. The query fails<br/> if there specified <code>query-filters</code> return no results. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_offset"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_offset"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_offset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_offset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_offset')" type="button"><span class="property-name">offset</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_offset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_offset" id="Call_parameters_items_i1_offset"> <div class="card-body pl-5"> <h4>Offset</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/> <span class="description"><p>This specifies the beginning offset of the results array. When combined with the <code>limit</code> query-option<br/> it may be used to implement pagination of large results arrays. WARNING: some query methods provide<br/> volatile results and the onus is on the developer to understand whether pagination is appropriate<br/> for a particular query API method. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_limit"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_limit"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_limit')" type="button"><span class="property-name">limit</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_limit" id="Call_parameters_items_i1_limit"> <div class="card-body pl-5"> <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/> <span class="description"><p>This specifies the maximum number of results matching the specified <code>query-filters</code> to return. When<br/> combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.<br/> WARNING: some query methods provide volatile results and the onus is on the developer to understand whether<br/> pagination is appropriate for a particular query API method. </p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_force_sql_filters"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_force_sql_filters"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_force_sql_filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_force_sql_filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_force_sql_filters')" type="button"><span class="property-name">force_sql_filters</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_force_sql_filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_force_sql_filters" id="Call_parameters_items_i1_force_sql_filters"> <div class="card-body pl-5"> <h4>Force Sql Filters</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value"> <div class="card"> <div class="card-header" id="headingReturn_value"> <h2 class="mb-0"> <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button> </h2> </div> <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value"> <div class="card-body pl-5"> <h4>Result</h4><br/> <div class="any-of-value" id="Return_value_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0" id="Return_value_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i1" id="Return_value_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i1')" role="tab">KeychainCredentialQueryResultItem</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i2" id="Return_value_anyOf_i2" onclick="setAnchor('#Return_value_anyOf_i2')" role="tab">Option 3</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: array of object</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_anyOf_i0_items"> <h4>KeychainCredentialQueryResultItem</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_id"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_id"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_id" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_id')" type="button"><span class="property-name">id</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_id" id="Return_value_anyOf_i0_items_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_name"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_name"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_name" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_name')" type="button"><span class="property-name">name</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_name" id="Return_value_anyOf_i0_items_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i0_items_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_type"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_type"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_type" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_type')" type="button"><span class="property-name">type</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_type" id="Return_value_anyOf_i0_items_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Return_value_anyOf_i0_items_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH_KEY_PAIR"</li><li class="list-group-item enum-item">"SSH_CREDENTIALS"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes')" type="button"><span class="property-name">attributes</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes" id="Return_value_anyOf_i0_items_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><br/> <div class="any-of-value" id="Return_value_anyOf_i0_items_attributes_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_items_attributes_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0" id="Return_value_anyOf_i0_items_attributes_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0')" role="tab">SSHKeyPair</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i1" id="Return_value_anyOf_i0_items_attributes_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1')" role="tab">SSHCredentials</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0" role="tabpanel"> <h4>SSHKeyPair</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>At least one of the two keys must be provided on creation.</p> </span> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i0_private_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i0_private_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key')" type="button"><span class="property-name">private_key</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i0_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i0_private_key" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key"> <div class="card-body pl-5"> <h4>Private Key</h4> <span class="badge badge-success default-value">Default: null</span><br/> <div class="any-of-value" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i0" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i1" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_private_key_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i0_public_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i0_public_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key')" type="button"><span class="property-name">public_key</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i0_public_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i0_public_key" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key"> <div class="card-body pl-5"> <h4>Public Key</h4> <span class="badge badge-success default-value">Default: null</span><br/> <span class="description"><p>Can be omitted and automatically derived from the private key.</p> </span><div class="any-of-value" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i0" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i1" id="Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: string</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i0_public_key_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i0_items_attributes_anyOf_i1" role="tabpanel"> <h4>SSHCredentials</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_host"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_host"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i1_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i1_host" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1_host')" type="button"><span class="property-name">host</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_host" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_host" id="Return_value_anyOf_i0_items_attributes_anyOf_i1_host"> <div class="card-body pl-5"> <h4>Host</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_port"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_port"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i1_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i1_port" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1_port')" type="button"><span class="property-name">port</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_port" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_port" id="Return_value_anyOf_i0_items_attributes_anyOf_i1_port"> <div class="card-body pl-5"> <h4>Port</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 22</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_username"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_username"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i1_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i1_username" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1_username')" type="button"><span class="property-name">username</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_username" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_username" id="Return_value_anyOf_i0_items_attributes_anyOf_i1_username"> <div class="card-body pl-5"> <h4>Username</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "root"</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_private_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_private_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i1_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i1_private_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1_private_key')" type="button"><span class="property-name">private_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_private_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_private_key" id="Return_value_anyOf_i0_items_attributes_anyOf_i1_private_key"> <div class="card-body pl-5"> <h4>Private Key</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Keychain Credential ID.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key')" type="button"><span class="property-name">remote_host_key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key" id="Return_value_anyOf_i0_items_attributes_anyOf_i1_remote_host_key"> <div class="card-body pl-5"> <h4>Remote Host Key</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Can be discovered with keychaincredential.remote<em>ssh</em>host<em>key</em>scan.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout" id="Return_value_anyOf_i0_items_attributes_anyOf_i1_connect_timeout"> <div class="card-body pl-5"> <h4>Connect Timeout</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 10</span><br/> </div> </div> </div> </div> </div></div></div> </div> </div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i1" role="tabpanel"> <h4>KeychainCredentialQueryResultItem</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionReturn_value_anyOf_i1_id"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_id"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_id" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_id')" type="button"><span class="property-name">id</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_id" id="Return_value_anyOf_i1_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_name"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_name"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_name" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_name')" type="button"><span class="property-name">name</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_name" id="Return_value_anyOf_i1_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_anyOf_i1_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_type"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_type"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_type" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_type')" type="button"><span class="property-name">type</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_type" id="Return_value_anyOf_i1_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <div class="enum-value" id="Return_value_anyOf_i1_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"SSH_KEY_PAIR"</li><li class="list-group-item enum-item">"SSH_CREDENTIALS"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_anyOf_i1_attributes"> <div class="card"> <div class="card-header" id="headingReturn_value_anyOf_i1_attributes"> <h2 class="mb-0"> <button aria-controls="Return_value_anyOf_i1_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_anyOf_i1_attributes" data-toggle="collapse" onclick="setAnchor('#Return_value_anyOf_i1_attributes')" type="button"><span class="property-name">attributes</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_anyOf_i1_attributes" class="collapse property-definition-div" data-parent="#accordionReturn_value_anyOf_i1_attributes" id="Return_value_anyOf_i1_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><br/> <div class="any-of-value" id="Return_value_anyOf_i1_attributes_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_i1_attributes_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i1_attributes_anyOf_i0" id="Return_value_anyOf_i1_attributes_anyOf_i0" onclick="setAnchor('#Return_value_anyOf_i1_attributes_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i1_attributes_anyOf_i1" id="Return_value_anyOf_i1_attributes_anyOf_i1" onclick="setAnchor('#Return_value_anyOf_i1_attributes_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_anyOf_i1_attributes_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: object</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i1_attributes_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: object</span><br/> </div></div></div> </div> </div> </div> </div> </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i2" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div></div></div> </div> </div> </div> </div> </div><br><br>

*Required roles:* KEYCHAIN_CREDENTIAL_READ

