> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sagescreen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Request a password reset email

> Sends a password-reset email to the given address. For security,
always returns a generic success message regardless of whether the
email exists.

Social-login users receive a different email explaining they
should log in via their social provider instead.

Registered as `wp_ajax_nopriv_sagescreen_password_reset` — **public**.




## OpenAPI

````yaml /openapi/private/specs/wp/auth.yml post /wp-admin/admin-ajax.php?action=sagescreen_password_reset
openapi: 3.1.0
info:
  title: SageScreen — Auth Module
  description: >
    Authentication and session management. Handles JWT token lifecycle

    (issue, refresh, validate, revoke) and WordPress-based login/logout

    with reCAPTCHA/Turnstile protection.


    Uses RS256-signed JWTs stored in the `wp_sage_screen_jwt` table.

    Tokens have a configurable TTL (`sage_screen_jwt_expires`, default 3600 s)

    and a separate refresh window (`sage_screen_jwt_refresh_expires`, default
    604800 s / 7 days).
  version: 1.0.0
servers:
  - url: https://{domain}/wp-json/sagescreen/v1
    description: WordPress REST API
    variables:
      domain:
        default: api.sagescreen.app
security: []
tags:
  - name: Auth – REST
    description: JWT token endpoints (REST API)
  - name: Auth – AJAX
    description: Session-based login / logout / password flows (AJAX)
paths:
  /wp-admin/admin-ajax.php?action=sagescreen_password_reset:
    post:
      tags:
        - Auth – AJAX
      summary: Request a password reset email
      description: |
        Sends a password-reset email to the given address. For security,
        always returns a generic success message regardless of whether the
        email exists.

        Social-login users receive a different email explaining they
        should log in via their social provider instead.

        Registered as `wp_ajax_nopriv_sagescreen_password_reset` — **public**.
      operationId: ajaxPasswordReset
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AjaxPasswordResetRequest'
      responses:
        '200':
          description: Reset request result
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/AjaxSuccessMessage'
                  - $ref: '#/components/schemas/AjaxErrorResponse'
              examples:
                success:
                  summary: Email sent (or user not found — same message)
                  value:
                    success: true
                    data:
                      message: >-
                        If an account exists with this email, a password reset
                        link has been sent.
                nonceFail:
                  summary: Nonce check failed
                  value:
                    success: false
                    data: Security check failed
                recaptchaFail:
                  summary: reCAPTCHA failed
                  value:
                    success: false
                    data: Security verification failed. Please try again.
                missingEmail:
                  summary: No email provided
                  value:
                    success: false
                    data: Email address is required
                keyFailed:
                  summary: WP could not generate reset key
                  value:
                    success: false
                    data: Could not generate reset key
                emailFailed:
                  summary: Email send exception
                  value:
                    success: false
                    data: Could not send reset email
      security: []
components:
  schemas:
    AjaxPasswordResetRequest:
      type: object
      required:
        - action
        - reset_nonce
        - recaptcha_token
        - reset_email
      properties:
        action:
          type: string
          const: sagescreen_password_reset
        reset_nonce:
          type: string
          description: WP nonce for `sagescreen_password_reset`
        recaptcha_token:
          type: string
          description: Turnstile / reCAPTCHA token (action `password_reset_request`)
        reset_email:
          type: string
          format: email
          examples:
            - john@example.com
    AjaxSuccessMessage:
      type: object
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          required:
            - message
          properties:
            message:
              type: string
              examples:
                - Password reset successfully
    AjaxErrorResponse:
      type: object
      description: |
        Standard AJAX error. The `data` field is either a plain string
        or an object with additional context (e.g. `no_council: true`).
      properties:
        success:
          type: boolean
          const: false
        data:
          oneOf:
            - type: string
              examples:
                - Security check failed
            - type: object
              properties:
                message:
                  type: string
                no_council:
                  type: boolean

````