acme.dns.authenticator.authenticator_schemas
============================================

Get the schemas for all DNS providers we support for ACME DNS Challenge and the respective attributes required for connecting to them while validating a DNS Challenge

.. 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> </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: array of object</span><br/> <span class="description"><p>Available DNS authenticator schemas with their configuration requirements.</p> </span> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Return_value_items"> <h4>ACMEDNSAuthenticatorSchema</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_items_key"> <div class="card"> <div class="card-header" id="headingReturn_value_items_key"> <h2 class="mb-0"> <button aria-controls="Return_value_items_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_key" data-toggle="collapse" onclick="setAnchor('#Return_value_items_key')" type="button"><span class="property-name">key</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_items_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_key" id="Return_value_items_key"> <div class="card-body pl-5"> <h4>Key</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Unique identifier for the DNS authenticator type.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_schema"> <div class="card"> <div class="card-header" id="headingReturn_value_items_schema"> <h2 class="mb-0"> <button aria-controls="Return_value_items_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_schema" data-toggle="collapse" onclick="setAnchor('#Return_value_items_schema')" type="button"><span class="property-name">schema</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_items_schema" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_schema" id="Return_value_items_schema"> <div class="card-body pl-5"> <h4>ACMEDNSAuthenticatorAttributeSchema</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="description"><p>Schema definition for the authenticator's required attributes.</p> </span> <div class="accordion" id="accordionReturn_value_items_schema__name_"> <div class="card"> <div class="card-header" id="headingReturn_value_items_schema__name_"> <h2 class="mb-0"> <button aria-controls="Return_value_items_schema__name_" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_schema__name_" data-toggle="collapse" onclick="setAnchor('#Return_value_items_schema__name_')" type="button"><span class="property-name">_name_</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_items_schema__name_" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_schema__name_" id="Return_value_items_schema__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>Internal name of the schema attribute.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_schema_title"> <div class="card"> <div class="card-header" id="headingReturn_value_items_schema_title"> <h2 class="mb-0"> <button aria-controls="Return_value_items_schema_title" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_schema_title" data-toggle="collapse" onclick="setAnchor('#Return_value_items_schema_title')" type="button"><span class="property-name">title</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_items_schema_title" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_schema_title" id="Return_value_items_schema_title"> <div class="card-body pl-5"> <h4>Title</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Human-readable title for the schema attribute.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_schema__required_"> <div class="card"> <div class="card-header" id="headingReturn_value_items_schema__required_"> <h2 class="mb-0"> <button aria-controls="Return_value_items_schema__required_" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_schema__required_" data-toggle="collapse" onclick="setAnchor('#Return_value_items_schema__required_')" type="button"><span class="property-name">_required_</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingReturn_value_items_schema__required_" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_schema__required_" id="Return_value_items_schema__required_"> <div class="card-body pl-5"> <h4> Required </h4><span class="badge badge-dark value-type">Type: boolean</span><br/> <span class="description"><p>Whether this attribute is required for the authenticator.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionReturn_value_items_schema_additionalProperties"> <div class="card"> <div class="card-header" id="headingReturn_value_items_schema_additionalProperties"> <h2 class="mb-0"> <button aria-controls="Return_value_items_schema_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_schema_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_items_schema_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button> </h2> </div> <div aria-labelledby="headingReturn_value_items_schema_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_schema_additionalProperties" id="Return_value_items_schema_additionalProperties"> <div class="card-body pl-5"><p class="additional-properties">Additional Properties of any type are allowed.</p> <span class="badge badge-dark value-type">Type: object</span><br/> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* READONLY_ADMIN

