---
title: "Requirereset"
method: POST
path: "/v1/b2b/passwords/email/require_reset"
tags: ["B2B Passwords"]
---

# Requirereset

`POST /v1/b2b/passwords/email/require_reset`

## Request

- Base URL: `https://api.stytch.com`
- URL: `https://api.stytch.com/v1/b2b/passwords/email/require_reset`
- Auth: HTTP basic

Require a password be reset by the associated email address. This endpoint is only functional for cross-org password use cases.

If there are is only one active Member using the associated email address in the Project, the password will be deleted.

## Headers

- `X-Stytch-Member-Session` string
- `X-Stytch-Member-SessionJWT` string

## Request body

- ApiB2bPasswordV1B2bPasswordsEmailRequireResetRequest: Request type
  - `email_address` string, required: 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 organization_slug or organization_external_id here as a convenience.
  - `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 for the member.

## Response `200`

Successful response

- ApiB2bPasswordV1B2bPasswordsEmailRequireResetResponse
  - `request_id` string, required: Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
  - `status_code` integer, required: The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
  - `member_id` string: Globally unique UUID that identifies a specific Member.
  - `member` ApiOrganizationV1Member
    - `organization_id` string, required: 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` string, required: 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.
    - `email_address` string, required: The email address of the Member.
    - `status` string, required: The status of the Member. The possible values are: `pending`, `invited`, `active`, or `deleted`.
    - `name` string, required: The name of the Member.
    - `sso_registrations` ApiOrganizationV1SSORegistration[], required: An array of registered [SAML Connection](https://stytch.com/docs/b2b/api/saml-connection-object) or [OIDC Connection](https://stytch.com/docs/b2b/api/oidc-connection-object) objects the Member has authenticated with.
      - `connection_id` string, required: Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
      - `external_id` string, required: The ID of the member given by the identity provider.
      - `registration_id` string, required: The unique ID of an SSO Registration.
      - `sso_attributes` object: An object for storing SSO attributes brought over from the identity provider.
    - `is_breakglass` boolean, required: Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. A break glass account is typically used for emergency purposes to gain access outside of normal authentication procedures. Refer to the [Organization object](https://stytch.com/docs/b2b/api/organization-object) and its `auth_methods` and `allowed_auth_methods` fields for more details.
    - `member_password_id` string, required: Globally unique UUID that identifies a Member's password.
    - `oauth_registrations` ApiOrganizationV1OAuthRegistration[], required: A list of OAuth registrations for this member.
      - `provider_type` string, required: Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
      - `provider_subject` string, required: The unique identifier for the User within a given OAuth provider. Also commonly called the `sub` or "Subject field" in OAuth protocols.
      - `member_oauth_registration_id` string, required: The unique ID of an OAuth registration.
      - `profile_picture_url` string: If available, the `profile_picture_url` is a URL of the User's profile picture set in OAuth identity the provider that the User has authenticated with, e.g. Google profile picture.
      - `locale` string: If available, the `locale` is the Member's locale set in the OAuth identity provider that the user has authenticated with.
    - `email_address_verified` boolean, required: Whether or not the Member's email address is verified.
    - `mfa_phone_number_verified` boolean, required: Whether or not the Member's phone number is verified.
    - `is_admin` boolean, required: Whether or not the Member has the `stytch_admin` Role. This Role is automatically granted to Members who create an Organization through the [discovery flow](https://stytch.com/docs/b2b/api/create-organization-via-discovery). See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/stytch-default) for more details on this Role.
    - `totp_registration_id` string, required: Globally unique UUID that identifies a TOTP instance.
    - `retired_email_addresses` ApiOrganizationV1RetiredEmail[], required: A list of retired email addresses for this member. A previously active email address can be marked as retired in one of two ways: - It's replaced with a new primary email address during an explicit Member update. - A new email address is surfaced by an OAuth, SAML or OIDC provider. In this case the new email address becomes the Member's primary email address and the old primary email address is retired. A retired email address cannot be used by other Members in the same Organization. However, unlinking retired email addresses allows them to be subsequently re-used by other Organization Members. Retired email addresses can be unlinked using the [Unlink Retired Email endpoint](https://stytch.com/docs/b2b/api/unlink-retired-member-email).
      - `email_id` string, required: The globally unique UUID of a Member's email.
      - `email_address` string, required: The email address of the Member.
    - `is_locked` boolean, required: Whether the Member is temporarily locked due to too many failed authentication attempts. See the [User Locking Guide](https://stytch.com/docs/resources/platform/user-locks) for more information.
    - `mfa_enrolled` boolean, required: Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to `REQUIRED_FOR_ALL`.
    - `mfa_phone_number` string, required: The Member's phone number. A Member may only have one phone number. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX).
    - `default_mfa_method` string, required: The Member's default MFA method. This value is used to determine which secondary MFA method to use in the case of multiple methods registered for a Member. The current possible values are `sms_otp` and `totp`.
    - `roles` ApiOrganizationV1MemberRole[], required: Explicit or implicit Roles assigned to this Member, along with details about the role assignment source. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.
      - `role_id` string, required: The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable. Reserved `role_id`s that are predefined by Stytch include: * `stytch_member` * `stytch_admin` Check out the [guide on Stytch default Roles](https://stytch.com/docs/b2b/guides/rbac/stytch-default) for a more detailed explanation.
      - `sources` ApiOrganizationV1MemberRoleSource[], required: A list of sources for this role assignment. A role assignment can come from multiple sources - for example, the Role could be both explicitly assigned and implicitly granted from the Member's email domain.
        - `type` string, required: The type of role assignment. The possible values are: `direct_assignment` – an explicitly assigned Role. Directly assigned roles can be updated by passing in the `roles` argument to the [Update Member](https://stytch.com/docs/b2b/api/update-member) endpoint. `email_assignment` – an implicit Role granted by the Member's email domain, regardless of their login method. Email implicit role assignments can be updated by passing in the `rbac_email_implicit_role_assignments` argument to the [Update Organization](https://stytch.com/docs/b2b/api/update-organization) endpoint. `sso_connection` – an implicit Role granted by the Member's SSO connection. This is currently only available for SAML connections and not for OIDC. If the Member has a SAML Member registration with the given connection, this role assignment will appear in the list. However, for authorization check purposes (in [sessions authenticate](https://stytch.com/docs/b2b/api/authenticate-session) or in any endpoint that enforces RBAC with session headers), the Member will only be granted the Role if their session contains an authentication factor with the specified SAML connection. SAML connection implicit role assignments can be updated by passing in the `saml_connection_implicit_role_assignments` argument to the [Update SAML connection](https://stytch.com/docs/b2b/api/update-saml-connection) endpoint. `sso_connection_group` – an implicit Role granted by the Member's SSO connection and group. This is currently only available for SAML connections and not for OIDC. If the Member has a SAML Member registration with the given connection, and belongs to a specific group within the IdP, this role assignment will appear in the list. However, for authorization check purposes (in [sessions authenticate](https://stytch.com/docs/b2b/api/authenticate-session) or in any endpoint that enforces RBAC with session headers), the Member will only be granted the role if their session contains an authentication factor with the specified SAML connection. SAML group implicit role assignments can be updated by passing in the `saml_group_implicit_role_assignments` argument to the [Update SAML connection](https://stytch.com/docs/b2b/api/update-saml-connection) endpoint. `scim_connection_group` – an implicit Role granted by the Member's SCIM connection and group. If the Member has a SCIM Member registration with the given connection, and belongs to a specific group within the IdP, this role assignment will appear in the list. SCIM group implicit role assignments can be updated by passing in the `scim_group_implicit_role_assignments` argument to the [Update SCIM connection](https://stytch.com/docs/b2b/api/update-scim-connection) endpoint.
        - `details` object: An object containing additional metadata about the source assignment. The fields will vary depending on the role assignment type as follows: `direct_assignment` – no additional details. `email_assignment` – will contain the email domain that granted the assignment. `sso_connection` – will contain the `connection_id` of the SAML connection that granted the assignment. `sso_connection_group` – will contain the `connection_id` of the SAML connection and the name of the `group` that granted the assignment. `scim_connection_group` – will contain the `connection_id` of the SAML connection and the `group_id` that granted the assignment.
    - `trusted_metadata` object: An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
    - `untrusted_metadata` object: An arbitrary JSON object of application-specific data. These fields can be edited directly by the frontend SDK, and should not be used to store critical information. See the [Metadata resource](https://stytch.com/docs/b2b/api/metadata) for complete field behavior details.
    - `created_at` string: The timestamp of the Member's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
    - `updated_at` string: The timestamp of when the Member was last updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
    - `scim_registration` ApiOrganizationV1SCIMRegistration
      - `connection_id` string, required: The ID of the SCIM connection.
      - `registration_id` string, required: The unique ID of a SCIM Registration.
      - `external_id` string: The ID of the member given by the identity provider.
      - `scim_attributes` ApiB2bScimV1SCIMAttributes
        - `user_name` string, required
        - `id` string, required
        - `external_id` string, required
        - `active` boolean, required
        - `groups` ApiB2bScimV1Group[], required
          - `value` string, required
          - `display` string, required
        - `display_name` string, required
        - `nick_name` string, required
        - `profile_url` string, required
        - `user_type` string, required
        - `title` string, required
        - `preferred_language` string, required
        - `locale` string, required
        - `timezone` string, required
        - `emails` ApiB2bScimV1Email[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `phone_numbers` ApiB2bScimV1PhoneNumber[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `addresses` ApiB2bScimV1Address[], required
          - `formatted` string, required
          - `street_address` string, required
          - `locality` string, required
          - `region` string, required
          - `postal_code` string, required
          - `country` string, required
          - `type` string, required
          - `primary` boolean, required
        - `ims` ApiB2bScimV1IMs[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `photos` ApiB2bScimV1Photo[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `entitlements` ApiB2bScimV1Entitlement[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `roles` ApiB2bScimV1Role[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `x509certificates` ApiB2bScimV1X509Certificate[], required
          - `value` string, required
          - `type` string, required
          - `primary` boolean, required
        - `name` ApiB2bScimV1Name
          - `formatted` string, required
          - `family_name` string, required
          - `given_name` string, required
          - `middle_name` string, required
          - `honorific_prefix` string, required
          - `honorific_suffix` string, required
        - `enterprise_extension` ApiB2bScimV1EnterpriseExtension
          - `employee_number` string, required
          - `cost_center` string, required
          - `division` string, required
          - `department` string, required
          - `organization` string, required
          - `manager` ApiB2bScimV1Manager
            - `value` string, required
            - `ref` string, required
            - `display_name` string, required
    - `external_id` string: The ID of the member given by the identity provider.
    - `lock_created_at` string: When the member lock was created, if there is one. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
    - `lock_expires_at` string: When the member lock expires, if there is one. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
  - `organization` ApiOrganizationV1Organization
    - `organization_id` string, required: 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.
    - `organization_name` string, required: The name of the Organization. Must be between 1 and 128 characters in length.
    - `organization_logo_url` string, required: The image URL of the Organization logo.
    - `organization_slug` string, required: The unique URL slug of the Organization. The slug only accepts alphanumeric characters and the following reserved characters: `-` `.` `_` `~`. Must be between 2 and 128 characters in length. Wherever an organization_id is expected in a path or request parameter, you may also use the organization_slug as a convenience.
    - `sso_jit_provisioning` string, required: The authentication setting that controls the JIT provisioning of Members when authenticating via SSO. The accepted values are: `ALL_ALLOWED` – the default setting, new Members will be automatically provisioned upon successful authentication via any of the Organization's `sso_active_connections`. `RESTRICTED` – only new Members with SSO logins that comply with `sso_jit_provisioning_allowed_connections` can be provisioned upon authentication. `NOT_ALLOWED` – disable JIT provisioning via SSO.
    - `sso_jit_provisioning_allowed_connections` string[], required: An array of `connection_id`s that reference [SAML Connection objects](https://stytch.com/docs/b2b/api/saml-connection-object). Only these connections will be allowed to JIT provision Members via SSO when `sso_jit_provisioning` is set to `RESTRICTED`.
    - `sso_active_connections` ApiOrganizationV1ActiveSSOConnection[], required: An array of active [SAML Connection references](https://stytch.com/docs/b2b/api/saml-connection-object) or [OIDC Connection references](https://stytch.com/docs/b2b/api/oidc-connection-object).
      - `connection_id` string, required: Globally unique UUID that identifies a specific SSO `connection_id` for a Member.
      - `display_name` string, required: A human-readable display name for the connection.
      - `identity_provider` string, required
    - `email_allowed_domains` string[], required: An array of email domains that allow invites or JIT provisioning for new Members. This list is enforced when either `email_invites` or `email_jit_provisioning` is set to `RESTRICTED`. Common domains such as `gmail.com` are not allowed. See the [common email domains resource](https://stytch.com/docs/b2b/api/common-email-domains) for the full list.
    - `email_jit_provisioning` string, required: The authentication setting that controls how a new Member can be provisioned by authenticating via Email Magic Link or OAuth. The accepted values are: `RESTRICTED` – only new Members with verified emails that comply with `email_allowed_domains` can be provisioned upon authentication via Email Magic Link or OAuth. `NOT_ALLOWED` – the default setting, disables JIT provisioning via Email Magic Link and OAuth.
    - `email_invites` string, required: The authentication setting that controls how a new Member can be invited to an organization by email. The accepted values are: `ALL_ALLOWED` – any new Member can be invited to join via email. `RESTRICTED` – only new Members with verified emails that comply with `email_allowed_domains` can be invited via email. `NOT_ALLOWED` – disable email invites.
    - `auth_methods` string, required: The setting that controls which authentication methods can be used by Members of an Organization. The accepted values are: `ALL_ALLOWED` – the default setting which allows all authentication methods to be used. `RESTRICTED` – only methods that comply with `allowed_auth_methods` can be used for authentication. This setting does not apply to Members with `is_breakglass` set to `true`.
    - `allowed_auth_methods` string[], required: An array of allowed authentication methods. This list is enforced when `auth_methods` is set to `RESTRICTED`. The list's accepted values are: `sso`, `magic_link`, `email_otp`, `password`, `google_oauth`, `microsoft_oauth`, `slack_oauth`, `github_oauth`, and `hubspot_oauth`.
    - `mfa_policy` string, required: The setting that controls the MFA policy for all Members in the Organization. The accepted values are: `REQUIRED_FOR_ALL` – All Members within the Organization will be required to complete MFA every time they wish to log in. However, any active Session that existed prior to this setting change will remain valid. `OPTIONAL` – The default value. The Organization does not require MFA by default for all Members. Members will be required to complete MFA only if their `mfa_enrolled` status is set to true.
    - `rbac_email_implicit_role_assignments` ApiOrganizationV1EmailImplicitRoleAssignment[], required: Implicit role assignments based off of email domains. For each domain-Role pair, all Members whose email addresses have the specified email domain will be granted the associated Role, regardless of their login method. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment.
      - `domain` string, required: Email domain that grants the specified Role.
      - `role_id` string, required: The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable. Reserved `role_id`s that are predefined by Stytch include: * `stytch_member` * `stytch_admin` Check out the [guide on Stytch default Roles](https://stytch.com/docs/b2b/guides/rbac/stytch-default) for a more detailed explanation.
    - `mfa_methods` string, required: The setting that controls which MFA methods can be used by Members of an Organization. The accepted values are: `ALL_ALLOWED` – the default setting which allows all authentication methods to be used. `RESTRICTED` – only methods that comply with `allowed_mfa_methods` can be used for authentication. This setting does not apply to Members with `is_breakglass` set to `true`.
    - `allowed_mfa_methods` string[], required: An array of allowed MFA authentication methods. This list is enforced when `mfa_methods` is set to `RESTRICTED`. The list's accepted values are: `sms_otp` and `totp`.
    - `oauth_tenant_jit_provisioning` string, required: The authentication setting that controls how a new Member can JIT provision into an organization by tenant. The accepted values are: `RESTRICTED` – only new Members with tenants in `allowed_oauth_tenants` can JIT provision via tenant. `NOT_ALLOWED` – the default setting, disables JIT provisioning by OAuth Tenant.
    - `claimed_email_domains` string[], required: A list of email domains that are claimed by the Organization.
    - `first_party_connected_apps_allowed_type` string, required: The authentication setting that sets the Organization's policy towards first party Connected Apps. The accepted values are: `ALL_ALLOWED` – the default setting, any first party Connected App in the Project is permitted for use by Members. `RESTRICTED` – only first party Connected Apps with IDs in `allowed_first_party_connected_apps` can be used by Members. `NOT_ALLOWED` – no first party Connected Apps are permitted.
    - `allowed_first_party_connected_apps` string[], required: An array of first party Connected App IDs that are allowed for the Organization. Only used when the Organization's `first_party_connected_apps_allowed_type` is `RESTRICTED`.
    - `third_party_connected_apps_allowed_type` string, required: The authentication setting that sets the Organization's policy towards third party Connected Apps. The accepted values are: `ALL_ALLOWED` – the default setting, any third party Connected App in the Project is permitted for use by Members. `RESTRICTED` – only third party Connected Apps with IDs in `allowed_first_party_connected_apps` can be used by Members. `NOT_ALLOWED` – no third party Connected Apps are permitted.
    - `allowed_third_party_connected_apps` string[], required: An array of third party Connected App IDs that are allowed for the Organization. Only used when the Organization's `third_party_connected_apps_allowed_type` is `RESTRICTED`.
    - `custom_roles` ApiOrganizationV1CustomRole[], required
      - `role_id` string, required
      - `description` string, required
      - `permissions` ApiOrganizationV1CustomRolePermission[], required
        - `resource_id` string, required
        - `actions` string[], required
    - `trusted_metadata` object: An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
    - `created_at` string: The timestamp of the Organization's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
    - `updated_at` string: The timestamp of when the Organization was last updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`.
    - `organization_external_id` string: A unique identifier for the organization.
    - `sso_default_connection_id` string: The default connection used for SSO when there are multiple active connections.
    - `scim_active_connection` ApiOrganizationV1ActiveSCIMConnection
      - `connection_id` string, required: The ID of the SCIM connection.
      - `display_name` string, required: A human-readable display name for the connection.
      - `bearer_token_last_four` string, required
      - `bearer_token_expires_at` string
    - `allowed_oauth_tenants` object: A map of allowed OAuth tenants. If this field is not passed in, the Organization will not allow JIT provisioning by OAuth Tenant. Allowed keys are "slack", "hubspot", and "github".

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `429`: Too Many Requests
- `500`: Internal server error

## Changes

- **2026-03-07** `110f26a94e5b`: 1 info
  - endpoint added
- **2026-03-06** `9cab20b8eca7`: 1 breaking
  - api path removed without deprecation
- **2026-01-09** `7dfcc14e566c`: 6 breaking, 1 info
  - the `member/roles/items/sources/items/details` response's property type changed from `string` to `object` for status `200`
  - the `member/sso_registrations/items/sso_attributes` response's property type changed from `string` to `object` for status `200`
  - the `member/trusted_metadata` response's property type changed from `string` to `object` for status `200`
  - the `member/untrusted_metadata` response's property type changed from `string` to `object` for status `200`
  - …3 more
- **2025-10-20** `a4801149ed74`: 2 info
  - added the new optional `header` request parameter `X-Stytch-Member-Session`
  - added the new optional `header` request parameter `X-Stytch-Member-SessionJWT`
- **2025-09-17** `8270cf3a3d4c`: 3 info
  - added the media type `application/json` for the response with the status `401`
  - added the media type `application/json` for the response with the status `500`
  - added the non-success response with the status `429`

[Operation history](https://skmtc.dev/stytch/apis/stytch-api/changes/v1/b2b/passwords/email/require_reset/post.md)

---

[API](https://skmtc.dev/stytch/apis/stytch-api.md) - [All operations](https://skmtc.dev/stytch/apis/stytch-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stytch/apis/stytch-api/revisions/6d1ff7474803?raw)