WorkOS · Schema

PasswordReset

AuthenticationIdentity ProviderSSOSAMLOIDCSCIMDirectory SyncAuthorizationFGAAudit LogsMFAB2B SaaSAgentsMCP

Properties

Name Type Description
object string Distinguishes the password reset object.
id string The unique ID of the password reset object.
user_id string The unique ID of the user.
email string The email address of the user.
expires_at string The timestamp when the password reset token expires.
created_at string The timestamp when the password reset token was created.
password_reset_token string The token used to reset the password.
password_reset_url string The URL where the user can reset their password.
View JSON Schema on GitHub

JSON Schema

workos-passwordreset-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PasswordReset",
  "title": "PasswordReset",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "description": "Distinguishes the password reset object.",
      "const": "password_reset"
    },
    "id": {
      "type": "string",
      "description": "The unique ID of the password reset object.",
      "example": "password_reset_01E4ZCR3C56J083X43JQXF3JK5"
    },
    "user_id": {
      "type": "string",
      "description": "The unique ID of the user.",
      "example": "user_01E4ZCR3C56J083X43JQXF3JK5"
    },
    "email": {
      "type": "string",
      "description": "The email address of the user.",
      "example": "[email protected]"
    },
    "expires_at": {
      "format": "date-time",
      "type": "string",
      "description": "The timestamp when the password reset token expires.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "created_at": {
      "format": "date-time",
      "type": "string",
      "description": "The timestamp when the password reset token was created.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "password_reset_token": {
      "type": "string",
      "description": "The token used to reset the password.",
      "example": "Z1uX3RbwcIl5fIGJJJCXXisdI"
    },
    "password_reset_url": {
      "type": "string",
      "description": "The URL where the user can reset their password.",
      "example": "https://your-app.com/reset-password?token=Z1uX3RbwcIl5fIGJJJCXXisdI"
    }
  },
  "required": [
    "object",
    "id",
    "user_id",
    "email",
    "expires_at",
    "created_at",
    "password_reset_token",
    "password_reset_url"
  ]
}