api_key.convert_raw_key
=======================

Convert a raw API key into its SCRAM authentication components.

This allows API key consumers to transform a raw API key (format: id-key) into the precomputed SCRAM authentication material for improved performance.

NOTE: this is a convenience function for API consumers. It does not impact API key stored server-side.

.. 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: raw_key</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>raw_key</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The raw API key to convert (format: id-key).</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </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>ApiKeyScramData</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>SCRAM authentication data derived from the raw API key.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_api_key_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_api_key_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_api_key_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_api_key_id" data-toggle="collapse" onclick="setAnchor('#Return_value_api_key_id')" type="button"><span class="property-name">api_key_id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_api_key_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_api_key_id" id="Return_value_api_key_id">
    <div class="card-body pl-5">
    <h4>Api Key Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>API key ID.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_iterations">
    <div class="card">
    <div class="card-header" id="headingReturn_value_iterations">
    <h2 class="mb-0">
    <button aria-controls="Return_value_iterations" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_iterations" data-toggle="collapse" onclick="setAnchor('#Return_value_iterations')" type="button"><span class="property-name">iterations</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_iterations" class="collapse property-definition-div" data-parent="#accordionReturn_value_iterations" id="Return_value_iterations">
    <div class="card-body pl-5">
    <h4>Iterations</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Number of iterations of PBKDF2-SHA512.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_salt">
    <div class="card">
    <div class="card-header" id="headingReturn_value_salt">
    <h2 class="mb-0">
    <button aria-controls="Return_value_salt" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_salt" data-toggle="collapse" onclick="setAnchor('#Return_value_salt')" type="button"><span class="property-name">salt</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_salt" class="collapse property-definition-div" data-parent="#accordionReturn_value_salt" id="Return_value_salt">
    <div class="card-body pl-5">
    <h4>Salt</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Base64 encoded salt for API key.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_client_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_client_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_client_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_client_key" data-toggle="collapse" onclick="setAnchor('#Return_value_client_key')" type="button"><span class="property-name">client_key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_client_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_client_key" id="Return_value_client_key">
    <div class="card-body pl-5">
    <h4>Client Key</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Pre-computed SCRAM ClientKey.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_stored_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_stored_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_stored_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_stored_key" data-toggle="collapse" onclick="setAnchor('#Return_value_stored_key')" type="button"><span class="property-name">stored_key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_stored_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_stored_key" id="Return_value_stored_key">
    <div class="card-body pl-5">
    <h4>Stored Key</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>SCRAM StoredKey for API key.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_server_key">
    <div class="card">
    <div class="card-header" id="headingReturn_value_server_key">
    <h2 class="mb-0">
    <button aria-controls="Return_value_server_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_server_key" data-toggle="collapse" onclick="setAnchor('#Return_value_server_key')" type="button"><span class="property-name">server_key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_server_key" class="collapse property-definition-div" data-parent="#accordionReturn_value_server_key" id="Return_value_server_key">
    <div class="card-body pl-5">
    <h4>Server Key</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>SCRAM ServerKey for API key.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* API_KEY_READ

