Stytch · Schema

api_b2b_password_v1_b2b_passwords_email_RequireResetRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
email_address string The email address of the Member to start the email reset process for.
organization_id string Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organi
member_id string Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set
View JSON Schema on GitHub

JSON Schema

stytch-api-b2b-password-v1-b2b-passwords-email-requireresetrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_password_v1_b2b_passwords_email_RequireResetRequest",
  "title": "api_b2b_password_v1_b2b_passwords_email_RequireResetRequest",
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address of the Member to start the email reset process for."
    },
    "organization_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience."
    },
    "member_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member."
    }
  },
  "description": "Request type",
  "required": [
    "email_address"
  ]
}