STstytch
B2B Passwords

Requirereset

Changed on

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.

post/v1/b2b/passwords/email/require_reset

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Headers

X-Stytch-Member-Sessionstring

A Stytch session that can be used to run the request with the given member's permissions.

X-Stytch-Member-SessionJWTstring

A Stytch Session JSON Web Token (JWT) that can be used to run the request with the given member's permissions.

Request body

email_addressstring required

The email address of the Member to start the email reset process for.

organization_idstring

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_idstring

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

Successful response

request_idstring 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_codeinteger 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_idstring

Globally unique UUID that identifies a specific Member.

Changes