api/documentation/topics/generated/validatePasswordResetToken.topic

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="Validate a customer password reset key" id="validatePasswordResetToken">

    <!-- AUTO-GENERATED, DO NOT EDIT -->
    <p>This endpoint documentation is generated directly from <code>openapi.yaml</code>.</p>
    <chapter title="Endpoint" id="endpoint">
        <code-block lang="http">GET /auth/password-reset/validate</code-block>
    </chapter>
    <chapter title="Operation" id="operation">
        <p>Operation ID: <code>validatePasswordResetToken</code></p>
        <p>Check if a password reset token is valid and hasn&#x27;t expired</p>
    </chapter>
    <chapter title="Authentication" id="authentication"><p>No authentication required.</p></chapter>
    <chapter title="Parameters" id="parameters">
        <table>
            <tr><td>Name</td><td>In</td><td>Required</td><td>Type</td><td>Description</td></tr>
            <tr><td>token</td><td>query</td><td>yes</td><td>string</td><td>The password reset token</td></tr>
        </table>
    </chapter>
    <chapter title="Responses" id="responses">
        <table>
            <tr><td>Status</td><td>Description</td><td>Content Types</td></tr>
            <tr><td>200</td><td>Token is valid</td><td>application/json</td></tr>
            <tr><td>404</td><td>Invalid or expired token</td><td>application/json</td></tr>
        </table>
        <p>Schema for response <code>200</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;properties&quot;: {
    &quot;customer_id&quot;: {
      &quot;type&quot;: &quot;integer&quot;
    },
    &quot;valid&quot;: {
      &quot;type&quot;: &quot;boolean&quot;
    }
  },
  &quot;type&quot;: &quot;object&quot;
}
        </code-block>
        <p>Schema for response <code>404</code> (<code>application/json</code>):</p>
        <code-block lang="json">
{
  &quot;$ref&quot;: &quot;#/components/schemas/Error&quot;
}
        </code-block>
    </chapter>
</topic>