{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/api_b2b_password_v1_b2b_passwords_existing_password_ResetRequest", "title": "api_b2b_password_v1_b2b_passwords_existing_password_ResetRequest", "type": "object", "properties": { "email_address": { "type": "string", "description": "The email address of the Member." }, "existing_password": { "type": "string", "description": "The Member's current password that they supplied." }, "new_password": { "type": "string", "description": "The Member's elected new password." }, "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." }, "session_token": { "type": "string", "description": "A secret token for a given Stytch Session." }, "session_duration_minutes": { "type": "integer", "format": "int32", "description": "Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist,\n returning both an opaque `session_token` and `session_jwt` for this session. Remember that the `session_jwt` will have a fixed lifetime of\n five minutes regardless of the underlying session duration, and will need to be refreshed over time.\n\n This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).\n\n If a `session_token` or `session_jwt` is provided then a successful authentication will continue to extend the session this many minutes.\n\n If the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration. If you don't want\n to use the Stytch session product, you can ignore the session fields in the response." }, "session_jwt": { "type": "string", "description": "The JSON Web Token (JWT) for a given Stytch Session." }, "session_custom_claims": { "type": "object", "additionalProperties": true, "description": "Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in\n `session_duration_minutes`. Claims will be included on the Session object and in the JWT. To update a key in an existing Session, supply a new value. To\n delete a key, supply a null value. Custom claims made with reserved claims (`iss`, `sub`, `aud`, `exp`, `nbf`, `iat`, `jti`) will be ignored.\n Total custom claims size cannot exceed four kilobytes." }, "locale": { "$ref": "#/components/schemas/api_b2b_password_v1_ResetRequestLocale", "description": "If the Member needs to complete an MFA step, and the Member has a phone number, this endpoint will pre-emptively send a one-time passcode (OTP) to the Member's phone number. The locale argument will be used to determine which language to use when sending the passcode.\n\nParameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `\"en\"`.\n\nCurrently supported languages are English (`\"en\"`), Spanish (`\"es\"`), and Brazilian Portuguese (`\"pt-br\"`); if no value is provided, the copy defaults to English.\n\nRequest support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link\")!\n" }, "telemetry_id": { "type": "string", "description": "If the `telemetry_id` is passed, as part of this request, Stytch will call the [Fingerprint Lookup API](https://stytch.com/docs/fraud/api/fingerprint-lookup) and store the associated fingerprints and IPGEO information for the Member. Your workspace must be enabled for Device Fingerprinting to use this feature." } }, "description": "Request type", "required": [ "email_address", "existing_password", "new_password", "organization_id" ] }