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

Sent on keychaincredential changes.

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionADDED"> <div class="card"> <div class="card-header" id="headingADDED"> <h2 class="mb-0"> <button aria-controls="ADDED" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED" data-toggle="collapse" onclick="setAnchor('#ADDED')" type="button"><span class="property-name">ADDED</span></button> </h2> </div> <div aria-labelledby="headingADDED" class="collapse property-definition-div" data-parent="#accordionADDED" id="ADDED"> <div class="card-body pl-5"> <h4>KeychainCredentialAddedEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionADDED_id"> <div class="card"> <div class="card-header" id="headingADDED_id"> <h2 class="mb-0"> <button aria-controls="ADDED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_id" data-toggle="collapse" onclick="setAnchor('#ADDED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_id" class="collapse property-definition-div" data-parent="#accordionADDED_id" id="ADDED_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields"> <div class="card"> <div class="card-header" id="headingADDED_fields"> <h2 class="mb-0"> <button aria-controls="ADDED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields" data-toggle="collapse" onclick="setAnchor('#ADDED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields" class="collapse property-definition-div" data-parent="#accordionADDED_fields" id="ADDED_fields"> <div class="card-body pl-5"> <h4>KeychainCredentialEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionADDED_fields_id"> <div class="card"> <div class="card-header" id="headingADDED_fields_id"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_id" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_id" class="collapse property-definition-div" data-parent="#accordionADDED_fields_id" id="ADDED_fields_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Unique identifier for this keychain credential.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_name"> <div class="card"> <div class="card-header" id="headingADDED_fields_name"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_name" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_name" class="collapse property-definition-div" data-parent="#accordionADDED_fields_name" id="ADDED_fields_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="ADDED_fields_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_type"> <div class="card"> <div class="card-header" id="headingADDED_fields_type"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_type" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_type" class="collapse property-definition-div" data-parent="#accordionADDED_fields_type" id="ADDED_fields_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>Type of credential stored in the keychain.</p> <ul> <li><code>SSH_KEY_PAIR</code>: SSH public/private key pair</li> <li><code>SSH_CREDENTIALS</code>: SSH connection credentials including host and authentication</li> </ul> </span><div class="enum-value" id="ADDED_fields_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="accordionADDED_fields_attributes"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_attributes" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes" id="ADDED_fields_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><br/> <span class="description"><p>Credential-specific configuration and authentication data.</p> </span><div class="any-of-value" id="ADDED_fields_attributes_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsADDED_fields_attributes_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_ADDED_fields_attributes_anyOf_i0" id="ADDED_fields_attributes_anyOf_i0" onclick="setAnchor('#ADDED_fields_attributes_anyOf_i0')" role="tab">SSHKeyPair</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_ADDED_fields_attributes_anyOf_i1" id="ADDED_fields_attributes_anyOf_i1" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_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="accordionADDED_fields_attributes_anyOf_i0_private_key"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i0_private_key"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i0_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i0_private_key" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_attributes_anyOf_i0_private_key')" type="button"><span class="property-name">private_key</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_attributes_anyOf_i0_private_key" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i0_private_key" id="ADDED_fields_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/> <span class="description"><p>SSH private key in OpenSSH format. <code>null</code> if only public key is provided.</p> </span><div class="any-of-value" id="ADDED_fields_attributes_anyOf_i0_private_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsADDED_fields_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_ADDED_fields_attributes_anyOf_i0_private_key_anyOf_i0" id="ADDED_fields_attributes_anyOf_i0_private_key_anyOf_i0" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_attributes_anyOf_i0_private_key_anyOf_i1" id="ADDED_fields_attributes_anyOf_i0_private_key_anyOf_i1" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_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_ADDED_fields_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="accordionADDED_fields_attributes_anyOf_i0_public_key"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i0_public_key"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i0_public_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i0_public_key" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_attributes_anyOf_i0_public_key')" type="button"><span class="property-name">public_key</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_attributes_anyOf_i0_public_key" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i0_public_key" id="ADDED_fields_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="ADDED_fields_attributes_anyOf_i0_public_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsADDED_fields_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_ADDED_fields_attributes_anyOf_i0_public_key_anyOf_i0" id="ADDED_fields_attributes_anyOf_i0_public_key_anyOf_i0" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_attributes_anyOf_i0_public_key_anyOf_i1" id="ADDED_fields_attributes_anyOf_i0_public_key_anyOf_i1" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_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_ADDED_fields_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_ADDED_fields_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="accordionADDED_fields_attributes_anyOf_i1_host"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i1_host"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i1_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i1_host" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_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="headingADDED_fields_attributes_anyOf_i1_host" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i1_host" id="ADDED_fields_attributes_anyOf_i1_host"> <div class="card-body pl-5"> <h4>Host</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>SSH server hostname or IP address.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_attributes_anyOf_i1_port"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i1_port"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i1_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i1_port" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_attributes_anyOf_i1_port')" type="button"><span class="property-name">port</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_attributes_anyOf_i1_port" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i1_port" id="ADDED_fields_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/> <span class="description"><p>SSH server port number.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_attributes_anyOf_i1_username"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i1_username"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i1_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i1_username" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_attributes_anyOf_i1_username')" type="button"><span class="property-name">username</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_attributes_anyOf_i1_username" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i1_username" id="ADDED_fields_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/> <span class="description"><p>SSH username for authentication.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_attributes_anyOf_i1_private_key"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i1_private_key"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i1_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i1_private_key" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_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="headingADDED_fields_attributes_anyOf_i1_private_key" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i1_private_key" id="ADDED_fields_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="accordionADDED_fields_attributes_anyOf_i1_remote_host_key"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i1_remote_host_key"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i1_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i1_remote_host_key" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_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="headingADDED_fields_attributes_anyOf_i1_remote_host_key" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i1_remote_host_key" id="ADDED_fields_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="accordionADDED_fields_attributes_anyOf_i1_connect_timeout"> <div class="card"> <div class="card-header" id="headingADDED_fields_attributes_anyOf_i1_connect_timeout"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_attributes_anyOf_i1_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_attributes_anyOf_i1_connect_timeout" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_attributes_anyOf_i1_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_attributes_anyOf_i1_connect_timeout" class="collapse property-definition-div" data-parent="#accordionADDED_fields_attributes_anyOf_i1_connect_timeout" id="ADDED_fields_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/> <span class="description"><p>Connection timeout in seconds for SSH connections.</p> </span> </div> </div> </div> </div> </div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED"> <div class="card"> <div class="card-header" id="headingCHANGED"> <h2 class="mb-0"> <button aria-controls="CHANGED" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED" data-toggle="collapse" onclick="setAnchor('#CHANGED')" type="button"><span class="property-name">CHANGED</span></button> </h2> </div> <div aria-labelledby="headingCHANGED" class="collapse property-definition-div" data-parent="#accordionCHANGED" id="CHANGED"> <div class="card-body pl-5"> <h4>KeychainCredentialChangedEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCHANGED_id"> <div class="card"> <div class="card-header" id="headingCHANGED_id"> <h2 class="mb-0"> <button aria-controls="CHANGED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_id" data-toggle="collapse" onclick="setAnchor('#CHANGED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_id" class="collapse property-definition-div" data-parent="#accordionCHANGED_id" id="CHANGED_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED_fields"> <div class="card"> <div class="card-header" id="headingCHANGED_fields"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields" id="CHANGED_fields"> <div class="card-body pl-5"> <h4>KeychainCredentialEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCHANGED_fields_id"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_id"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_id" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_id" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_id" id="CHANGED_fields_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Unique identifier for this keychain credential.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED_fields_name"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_name"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_name" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_name" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_name" id="CHANGED_fields_name"> <div class="card-body pl-5"> <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Distinguishes this Keychain Credential from others.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="CHANGED_fields_name_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED_fields_type"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_type"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_type" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_type" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_type" id="CHANGED_fields_type"> <div class="card-body pl-5"> <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>Type of credential stored in the keychain.</p> <ul> <li><code>SSH_KEY_PAIR</code>: SSH public/private key pair</li> <li><code>SSH_CREDENTIALS</code>: SSH connection credentials including host and authentication</li> </ul> </span><div class="enum-value" id="CHANGED_fields_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="accordionCHANGED_fields_attributes"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_attributes')" type="button"><span class="property-name">attributes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_attributes" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes" id="CHANGED_fields_attributes"> <div class="card-body pl-5"> <h4>Attributes</h4><br/> <span class="description"><p>Credential-specific configuration and authentication data.</p> </span><div class="any-of-value" id="CHANGED_fields_attributes_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCHANGED_fields_attributes_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_fields_attributes_anyOf_i0" id="CHANGED_fields_attributes_anyOf_i0" onclick="setAnchor('#CHANGED_fields_attributes_anyOf_i0')" role="tab">SSHKeyPair</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_fields_attributes_anyOf_i1" id="CHANGED_fields_attributes_anyOf_i1" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_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="accordionCHANGED_fields_attributes_anyOf_i0_private_key"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i0_private_key"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i0_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i0_private_key" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_attributes_anyOf_i0_private_key')" type="button"><span class="property-name">private_key</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_attributes_anyOf_i0_private_key" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i0_private_key" id="CHANGED_fields_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/> <span class="description"><p>SSH private key in OpenSSH format. <code>null</code> if only public key is provided.</p> </span><div class="any-of-value" id="CHANGED_fields_attributes_anyOf_i0_private_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCHANGED_fields_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_CHANGED_fields_attributes_anyOf_i0_private_key_anyOf_i0" id="CHANGED_fields_attributes_anyOf_i0_private_key_anyOf_i0" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_attributes_anyOf_i0_private_key_anyOf_i1" id="CHANGED_fields_attributes_anyOf_i0_private_key_anyOf_i1" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_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_CHANGED_fields_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="accordionCHANGED_fields_attributes_anyOf_i0_public_key"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i0_public_key"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i0_public_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i0_public_key" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_attributes_anyOf_i0_public_key')" type="button"><span class="property-name">public_key</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_attributes_anyOf_i0_public_key" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i0_public_key" id="CHANGED_fields_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="CHANGED_fields_attributes_anyOf_i0_public_key_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCHANGED_fields_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_CHANGED_fields_attributes_anyOf_i0_public_key_anyOf_i0" id="CHANGED_fields_attributes_anyOf_i0_public_key_anyOf_i0" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_attributes_anyOf_i0_public_key_anyOf_i1" id="CHANGED_fields_attributes_anyOf_i0_public_key_anyOf_i1" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_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_CHANGED_fields_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_CHANGED_fields_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="accordionCHANGED_fields_attributes_anyOf_i1_host"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i1_host"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i1_host" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i1_host" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_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="headingCHANGED_fields_attributes_anyOf_i1_host" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i1_host" id="CHANGED_fields_attributes_anyOf_i1_host"> <div class="card-body pl-5"> <h4>Host</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>SSH server hostname or IP address.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED_fields_attributes_anyOf_i1_port"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i1_port"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i1_port" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i1_port" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_attributes_anyOf_i1_port')" type="button"><span class="property-name">port</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_attributes_anyOf_i1_port" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i1_port" id="CHANGED_fields_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/> <span class="description"><p>SSH server port number.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED_fields_attributes_anyOf_i1_username"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i1_username"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i1_username" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i1_username" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_attributes_anyOf_i1_username')" type="button"><span class="property-name">username</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_attributes_anyOf_i1_username" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i1_username" id="CHANGED_fields_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/> <span class="description"><p>SSH username for authentication.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCHANGED_fields_attributes_anyOf_i1_private_key"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i1_private_key"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i1_private_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i1_private_key" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_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="headingCHANGED_fields_attributes_anyOf_i1_private_key" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i1_private_key" id="CHANGED_fields_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="accordionCHANGED_fields_attributes_anyOf_i1_remote_host_key"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i1_remote_host_key"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i1_remote_host_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i1_remote_host_key" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_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="headingCHANGED_fields_attributes_anyOf_i1_remote_host_key" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i1_remote_host_key" id="CHANGED_fields_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="accordionCHANGED_fields_attributes_anyOf_i1_connect_timeout"> <div class="card"> <div class="card-header" id="headingCHANGED_fields_attributes_anyOf_i1_connect_timeout"> <h2 class="mb-0"> <button aria-controls="CHANGED_fields_attributes_anyOf_i1_connect_timeout" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_attributes_anyOf_i1_connect_timeout" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_attributes_anyOf_i1_connect_timeout')" type="button"><span class="property-name">connect_timeout</span></button> </h2> </div> <div aria-labelledby="headingCHANGED_fields_attributes_anyOf_i1_connect_timeout" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_attributes_anyOf_i1_connect_timeout" id="CHANGED_fields_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/> <span class="description"><p>Connection timeout in seconds for SSH connections.</p> </span> </div> </div> </div> </div> </div></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionREMOVED"> <div class="card"> <div class="card-header" id="headingREMOVED"> <h2 class="mb-0"> <button aria-controls="REMOVED" aria-expanded="" class="btn btn-link property-name-button" data-target="#REMOVED" data-toggle="collapse" onclick="setAnchor('#REMOVED')" type="button"><span class="property-name">REMOVED</span></button> </h2> </div> <div aria-labelledby="headingREMOVED" class="collapse property-definition-div" data-parent="#accordionREMOVED" id="REMOVED"> <div class="card-body pl-5"> <h4>KeychainCredentialRemovedEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionREMOVED_id"> <div class="card"> <div class="card-header" id="headingREMOVED_id"> <h2 class="mb-0"> <button aria-controls="REMOVED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#REMOVED_id" data-toggle="collapse" onclick="setAnchor('#REMOVED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingREMOVED_id" class="collapse property-definition-div" data-parent="#accordionREMOVED_id" id="REMOVED_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* KEYCHAIN_CREDENTIAL_READ

