Class: StytchB2B::Passwords::Email

Inherits:

Object

Object
StytchB2B::Passwords::Email

show all

Includes:: Stytch::RequestHelper

Defined in:: lib/stytch/b2b_passwords.rb

Defined Under Namespace

Classes: RequireResetRequestOptions

Instance Method Summary collapse

#initialize(connection) ⇒ Email constructor

A new instance of Email.
#require_reset(email_address:, organization_id: nil, member_id: nil, method_options: nil) ⇒ Object

Require a password be reset by the associated email address.
#reset(password_reset_token:, password:, session_token: nil, session_duration_minutes: nil, session_jwt: nil, code_verifier: nil, session_custom_claims: nil, locale: nil, intermediate_session_token: nil) ⇒ Object

Reset the’s password and authenticate them.
#reset_start(organization_id:, email_address:, reset_password_redirect_url: nil, reset_password_expiration_minutes: nil, code_challenge: nil, login_redirect_url: nil, locale: nil, reset_password_template_id: nil) ⇒ Object

Initiates a password reset for the email address provided.

Methods included from Stytch::RequestHelper

#delete_request, #get_request, #post_request, #put_request, #request_with_query_params

Constructor Details

#initialize(connection) ⇒ `Email`

Returns a new instance of Email.



352
353
354

# File 'lib/stytch/b2b_passwords.rb', line 352

def initialize(connection)
  @connection = connection
end

Instance Method Details

#require_reset(email_address:, organization_id: nil, member_id: nil, method_options: nil) ⇒ `Object`

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

Parameters:

email_address: The email address of the Member to start the email reset process for. The type of this field is String.
organization_id: 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. The type of this field is nilable String.
member_id: 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. The type of this field is nilable String.

Returns:

An object with the following fields:

member: The [Member object](stytch.com/docs/b2b/api/member-object) The type of this field is Member (object).
organization: The [Organization object](stytch.com/docs/b2b/api/organization-object). The type of this field is Organization (object).
status_code: 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. The type of this field is Integer.
member_id: Globally unique UUID that identifies a specific Member. The type of this field is nilable String.

Method Options:

This method supports an optional StytchB2B::Passwords::Email::RequireResetRequestOptions object which will modify the headers sent in the HTTP request.

# File 'lib/stytch/b2b_passwords.rb', line 604

def require_reset(
  email_address:,
  organization_id: nil,
  member_id: nil,
  method_options: nil
)
  headers = {}
  headers = headers.merge(method_options.to_headers) unless method_options.nil?
  request = {
    email_address: email_address
  }
  request[:organization_id] = organization_id unless organization_id.nil?
  request[:member_id] = member_id unless member_id.nil?

  post_request('/v1/b2b/passwords/email/require_reset', request, headers)
end

#reset(password_reset_token:, password:, session_token: nil, session_duration_minutes: nil, session_jwt: nil, code_verifier: nil, session_custom_claims: nil, locale: nil, intermediate_session_token: nil) ⇒ `Object`

Reset the’s password and authenticate them. This endpoint checks that the password reset token is valid, hasn’t expired, or already been used.

The provided password needs to meet our password strength requirements, which can be checked in advance with the password strength endpoint. If the token and password are accepted, the password is securely stored for future authentication and the user is authenticated.

If the Member is required to complete MFA to log in to the Organization, the returned value of ‘member_authenticated` will be `false`, and an `intermediate_session_token` will be returned. The `intermediate_session_token` can be passed into the [OTP SMS Authenticate endpoint](stytch.com/docs/b2b/api/authenticate-otp-sms) to complete the MFA step and acquire a full member session. The `session_duration_minutes` and `session_custom_claims` parameters will be ignored.

If a valid ‘session_token` or `session_jwt` is passed in, the Member will not be required to complete an MFA step.

Note that a successful password reset by email will revoke all active sessions for the ‘member_id`.

Parameters:

password_reset_token

The password reset token to authenticate. The type of this field is String.

password

The password to authenticate, reset, or set for the first time. Any UTF8 character is allowed, e.g. spaces, emojis, non-English characers, etc. The type of this field is String.

session_token

Reuse an existing session instead of creating a new one. If you provide a ‘session_token`, Stytch will update the session.

If the `session_token` and `magic_links_token` belong to different Members, the `session_token` will be ignored. This endpoint will error if
both `session_token` and `session_jwt` are provided.

The type of this field is nilable String.

session_duration_minutes

Set the session lifetime to be this many minutes from now. This will start a new session if one doesn’t already exist, returning both an opaque ‘session_token` and `session_jwt` for this session. Remember that the `session_jwt` will have a fixed lifetime of five minutes regardless of the underlying session duration, and will need to be refreshed over time.

This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).

If a ‘session_token` or `session_jwt` is provided then a successful authentication will continue to extend the session this many minutes.

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 to use the Stytch session product, you can ignore the session fields in the response. The type of this field is nilable Integer.

session_jwt

Reuse an existing session instead of creating a new one. If you provide a ‘session_jwt`, Stytch will update the session. If the `session_jwt`

and `magic_links_token` belong to different Members, the `session_jwt` will be ignored. This endpoint will error if both `session_token` and `session_jwt`
are provided.

The type of this field is nilable String.

code_verifier

A base64url encoded one time secret used to validate that the request starts and ends on the same device. The type of this field is nilable String.

session_custom_claims

Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in ‘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 delete a key, supply a null value. Custom claims made with reserved claims (`iss`, `sub`, `aud`, `exp`, `nbf`, `iat`, `jti`) will be ignored. Total custom claims size cannot exceed four kilobytes. The type of this field is nilable object.

locale

If the 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.

Parameter is a [IETF BCP 47 language tag](www.w3.org/International/articles/language-tags/), e.g. ‘“en”`.

Currently supported languages are English (‘“en”`), Spanish (`“es”`), and Brazilian Portuguese (`“pt-br”`); if no value is provided, the copy defaults to English.

Request support for additional languages [here](docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link“)!

The type of this field is nilable +ResetRequestLocale+ (string enum).

intermediate_session_token: Adds this primary authentication factor to the intermediate session token. If the resulting set of factors satisfies the organization’s primary authentication requirements and MFA requirements, the intermediate session token will be consumed and converted to a member session. If not, the same intermediate session token will be returned. The type of this field is nilable String.

Returns:

An object with the following fields:

request_id: 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. The type of this field is String.
member_id: Globally unique UUID that identifies a specific Member. The type of this field is String.
member_email_id: Globally unique UUID that identifies a member’s email The type of this field is String.
organization_id: 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. The type of this field is String.
member: The [Member object](stytch.com/docs/b2b/api/member-object) The type of this field is Member (object).
session_token: A secret token for a given Stytch Session. The type of this field is String.
session_jwt: The JSON Web Token (JWT) for a given Stytch Session. The type of this field is String.
organization: The [Organization object](stytch.com/docs/b2b/api/organization-object). The type of this field is Organization (object).
intermediate_session_token: The returned Intermediate Session Token contains a password factor associated with the Member. If this value is non-empty, the member must complete an MFA step to finish logging in to the Organization. The token can be used with the [OTP SMS Authenticate endpoint](stytch.com/docs/b2b/api/authenticate-otp-sms), [TOTP Authenticate endpoint](stytch.com/docs/b2b/api/authenticate-totp), or [Recovery Codes Recover endpoint](stytch.com/docs/b2b/api/recovery-codes-recover) to complete an MFA flow and log in to the Organization. Password factors are not transferable between Organizations, so the intermediate session token is not valid for use with discovery endpoints. The type of this field is String.
member_authenticated: Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization. The type of this field is Boolean.
status_code: 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. The type of this field is Integer.
member_session: The [Session object](stytch.com/docs/b2b/api/session-object). The type of this field is nilable MemberSession (object).
mfa_required: Information about the MFA requirements of the Organization and the Member’s options for fulfilling MFA. The type of this field is nilable MfaRequired (object).

# File 'lib/stytch/b2b_passwords.rb', line 547

def reset(
  password_reset_token:,
  password:,
  session_token: nil,
  session_duration_minutes: nil,
  session_jwt: nil,
  code_verifier: nil,
  session_custom_claims: nil,
  locale: nil,
  intermediate_session_token: nil
)
  headers = {}
  request = {
    password_reset_token: password_reset_token,
    password: password
  }
  request[:session_token] = session_token unless session_token.nil?
  request[:session_duration_minutes] = session_duration_minutes unless session_duration_minutes.nil?
  request[:session_jwt] = session_jwt unless session_jwt.nil?
  request[:code_verifier] = code_verifier unless code_verifier.nil?
  request[:session_custom_claims] = session_custom_claims unless session_custom_claims.nil?
  request[:locale] = locale unless locale.nil?
  request[:intermediate_session_token] = intermediate_session_token unless intermediate_session_token.nil?

  post_request('/v1/b2b/passwords/email/reset', request, headers)
end

#reset_start(organization_id:, email_address:, reset_password_redirect_url: nil, reset_password_expiration_minutes: nil, code_challenge: nil, login_redirect_url: nil, locale: nil, reset_password_template_id: nil) ⇒ `Object`

Initiates a password reset for the email address provided. This will trigger an email to be sent to the address, containing a magic link that will allow them to set a new password and authenticate.

This endpoint adapts to your Project’s password strength configuration. If you’re using [zxcvbn](stytch.com/docs/guides/passwords/strength-policy), the default, your passwords are considered valid if the strength score is >= 3. If you’re using [LUDS](stytch.com/docs/guides/passwords/strength-policy), your passwords are considered valid if they meet the requirements that you’ve set with Stytch. You may update your password strength configuration in the [stytch dashboard](stytch.com/dashboard/password-strength-config).

Parameters:

organization_id

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. The type of this field is String.

email_address

The email address of the Member to start the email reset process for. The type of this field is String.

reset_password_redirect_url

The URL that the Member clicks from the reset password link. This URL should be an endpoint in the backend server that verifies the request by querying Stytch’s authenticate endpoint and finishes the reset password flow. If this value is not passed, the default ‘reset_password_redirect_url` that you set in your Dashboard is used. If you have not set a default `reset_password_redirect_url`, an error is returned. The type of this field is nilable String.

reset_password_expiration_minutes

Sets a time limit after which the email link to reset the member’s password will no longer be valid. The type of this field is nilable Integer.

code_challenge

A base64url encoded SHA256 hash of a one time secret used to validate that the request starts and ends on the same device. The type of this field is nilable String.

login_redirect_url

The URL that the member clicks from the reset without password link. This URL should be an endpoint in the backend server

that verifies the request by querying Stytch's authenticate endpoint and finishes the magic link flow. If this value is not passed, the
default `login_redirect_url` that you set in your Dashboard is used. This value is only used if magic links are enabled for the member. If
you have not set a default `login_redirect_url` and magic links are not enabled for the member, an error is returned.

The type of this field is nilable String.

locale

Used to determine which language to use when sending the user this delivery method. Parameter is a [IETF BCP 47 language tag](www.w3.org/International/articles/language-tags/), e.g. ‘“en”`.

Currently supported languages are English (‘“en”`), Spanish (`“es”`), and Brazilian Portuguese (`“pt-br”`); if no value is provided, the copy defaults to English.

Request support for additional languages [here](docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link“)!

The type of this field is nilable +ResetStartRequestLocale+ (string enum).

reset_password_template_id: Use a custom template for reset password emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Magic Links - Reset Password. The type of this field is nilable String.

Returns:

An object with the following fields:

request_id: 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. The type of this field is String.
member_id: Globally unique UUID that identifies a specific Member. The type of this field is String.
member_email_id: Globally unique UUID that identifies a member’s email The type of this field is String.
member: The [Member object](stytch.com/docs/b2b/api/member-object) The type of this field is Member (object).
status_code: 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. The type of this field is Integer.

# File 'lib/stytch/b2b_passwords.rb', line 417

def reset_start(
  organization_id:,
  email_address:,
  reset_password_redirect_url: nil,
  reset_password_expiration_minutes: nil,
  code_challenge: nil,
  login_redirect_url: nil,
  locale: nil,
  reset_password_template_id: nil
)
  headers = {}
  request = {
    organization_id: organization_id,
    email_address: email_address
  }
  request[:reset_password_redirect_url] = reset_password_redirect_url unless reset_password_redirect_url.nil?
  request[:reset_password_expiration_minutes] = reset_password_expiration_minutes unless reset_password_expiration_minutes.nil?
  request[:code_challenge] = code_challenge unless code_challenge.nil?
  request[:login_redirect_url] = login_redirect_url unless login_redirect_url.nil?
  request[:locale] = locale unless locale.nil?
  request[:reset_password_template_id] = reset_password_template_id unless reset_password_template_id.nil?

  post_request('/v1/b2b/passwords/email/reset/start', request, headers)
end

Class: StytchB2B::Passwords::Email

Defined Under Namespace

Instance Method Summary collapse

Methods included from Stytch::RequestHelper

Constructor Details

#initialize(connection) ⇒ Email

Instance Method Details

#require_reset(email_address:, organization_id: nil, member_id: nil, method_options: nil) ⇒ Object

Parameters:

Returns:

Method Options:

#reset(password_reset_token:, password:, session_token: nil, session_duration_minutes: nil, session_jwt: nil, code_verifier: nil, session_custom_claims: nil, locale: nil, intermediate_session_token: nil) ⇒ Object

Parameters:

Returns:

#reset_start(organization_id:, email_address:, reset_password_redirect_url: nil, reset_password_expiration_minutes: nil, code_challenge: nil, login_redirect_url: nil, locale: nil, reset_password_template_id: nil) ⇒ Object

Parameters:

Returns:

#initialize(connection) ⇒ `Email`

#require_reset(email_address:, organization_id: nil, member_id: nil, method_options: nil) ⇒ `Object`

#reset(password_reset_token:, password:, session_token: nil, session_duration_minutes: nil, session_jwt: nil, code_verifier: nil, session_custom_claims: nil, locale: nil, intermediate_session_token: nil) ⇒ `Object`

#reset_start(organization_id:, email_address:, reset_password_redirect_url: nil, reset_password_expiration_minutes: nil, code_challenge: nil, login_redirect_url: nil, locale: nil, reset_password_template_id: nil) ⇒ `Object`