Request Password Reset API

Initiate the password reset process by sending a reset code to the user's email

Public

Request Password Reset API

Start the password reset process. Send a verification code to the user's registered email address to enable password recovery.

Email Delivery

Reset code sent via email.

Secure Process

Time-limited reset codes.

Self-Service

No authentication needed.


Endpoint Overview

MUTATION/graphql

Initiate password reset by sending a verification code to the user's registered email address. The code is required for the next step of the reset process.

Authentication:No Auth Required

Request Parameters

emailString!Required

The email address associated with the user account.


GraphQL Mutation

mutation requestResetPassword($email: String!) {
  requestResetPassword(email: $email) {
    success
    message
  }
}

Variables:

{
  "email": "user@example.com"
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -d '{
    "query": "mutation requestResetPassword($email: String!) { requestResetPassword(email: $email) { success message } }",
    "variables": {
      "email": "user@example.com"
    }
  }'

Response

200Reset Email Sent
{
  "data": {
    "requestResetPassword": {
      "success": true,
      "message": "Password reset instructions have been sent to your email"
    }
  }
}
400Email Not Found
{
  "errors": [
    {
      "message": "No account found with this email address",
      "path": ["requestResetPassword"],
      "extensions": {
        "code": "EMAIL_NOT_FOUND"
      }
    }
  ],
  "data": null
}
429Too Many Requests
{
  "errors": [
    {
      "message": "Too many reset requests. Please try again later",
      "path": ["requestResetPassword"],
      "extensions": {
        "code": "RATE_LIMITED"
      }
    }
  ],
  "data": null
}

Password Reset Flow

Request Reset

Receive Code

Verify Code

Reset Password


Security Measures

Rate Limiting

Prevents abuse of reset requests.

Code Expiration

Reset codes expire after 15 minutes.

No Enumeration

Response doesn't reveal if email exists.

One Code Active

New request invalidates old codes.


Best Practices

Check Email

Look in inbox and spam folder.

Act Quickly

Use reset code before expiration.

Single Request

Wait before requesting again.

Secure New Password

Choose strong new password.



Email Delivery

Check your spam/junk folder if you don't receive the reset email within a few minutes. Contact support if issues persist.

Received Your Code?

Proceed to verify your reset code and set a new password.

Verify Reset Code