session.exchange wraps the Exchange Session endpoint. Use it to exchange a current session for one in a different , allowing a user to switch between multiple Organizations without having to log out and back in.
If this method succeeds and the Member is not required to complete MFA, the Member will be logged in, granted an active session, and the .
If this method succeeds and MFA is required, the will be
Parameters
The id of the Organization to exchange the session into.
Set the session lifetime to be this many minutes from now. This will return both an opaque
session_token and session_jwt for this session, which will automatically be stored in the browser cookies. The session_jwt will have a fixed lifetime of five minutes regardless of the underlying session duration, and will be automatically refreshed by the SDK in the background over time.This value must be a minimum of 5 and may not exceed the maximum session duration minutes value set in the Frontend SDK page of the Stytch Dashboard.A successful authentication will continue to extend the session this many minutes.Used to determine which language to use when sending the user this delivery method. Parameter is an IETF BCP 47 language tag, e.g. “en”.Supported languages are English (“en”), Spanish (“es”), French (“fr”) and Brazilian Portuguese (“pt-br”); if no value is provided, the copy defaults to English.
Response
The unique ID of the Member.
The JWT for the new Stytch Session.
The secret token for the new Stytch Session.
The
intermediate_session_token that should be passed into a secondary authentication endpoint, such as OTP authenticate, in order to receive a member session. The intermediate_session_token can also be used with discovery endpoints to join a different organization or create a new organization.If the member is fully authenticated, this field will be an empty string.If the project is configured to use HttpOnly cookies, this field will always be an empty string.
Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
Information about the MFA requirements of the Organization and the Member’s options for fulfilling MFA. This field is only returned if the Member needs to complete MFA to log in to the Organization.
Show properties
Show properties
If null, indicates that no secondary authentication has been initiated. If equal to
sms_otp, indicates that the Member has a phone number, and a one time passcode has been sent to the Member’s phone number. No secondary authentication will be initiated during calls to the discovery authenticate or list organizations endpoints, even if the Member has a phone number.The new Stytch Session.
Show properties
Show properties
Globally unique UUID that identifies the Session.
Globally unique UUID that identifies a specific Member.
An array of authentication factors that comprise a Session.
Show properties
Show properties
The type of authentication factor. The possible values are:
email_otp, impersonated, imported, magic_link, oauth, otp, password, recovery_codes, sso, trusted_auth_token, or totp.The method that was used to deliver the authentication factor. The possible values depend on the type:
email_otp: Onlyemail.impersonated: Onlyimpersonation.imported: Onlyimported_auth0.magic_link: Onlyemail.oauth:oauth_google,oauth_microsoft,oauth_hubspot,oauth_slack, oroauth_github. You may see an ‘exchange’ delivery method when a non-email-verifying OAuth factor originally authenticated in one organization is exchanged for a factor in another organization. This can happen during authentication flows such as session exchange. The non-email-verifying OAuth providers are Hubspot, Slack, and Github. Google is also considered non-email-verifying when the HD claim is empty. The possible exchange values areoauth_exchange_google,oauth_exchange_hubspot,oauth_exchange_slack, oroauth_exchange_github. The final possible value isoauth_access_token_exchange, if this factor came from an access token exchange flow.otp: Onlysms.password: Onlyknowledge.recovery_codes: Onlyrecovery_code.sso:sso_samlorsso_oidc.trusted_auth_token: Onlytrusted_token_exchange.totp: Onlyauthenticator_app.
The timestamp when the factor was initially authenticated.
The timestamp when the factor was last authenticated.
The timestamp when the factor was last updated.
Either
PRIMARY or SECONDARY. Secondary factor types include otp, totp, and recovery_codes. All other factors are primary.Information about the Google OAuth factor, if one is present.
Information about the Microsoft OAuth factor, if one is present.
Information about the Hubspot OAuth factor, if one is present.
Information about the Github OAuth factor, if one is present.
Information about the Slack OAuth factor, if one is present.
Information about the Google OAuth Exchange factor, if one is present.
Show properties
Show properties
The globally unique UUID of the email address.
Information about the Hubspot OAuth Exchange factor, if one is present.
Show properties
Show properties
The globally unique UUID of the email address.
Information about the Github OAuth Exchange factor, if one is present.
Show properties
Show properties
The globally unique UUID of the email address.
Information about the Slack OAuth Exchange factor, if one is present.
Show properties
Show properties
The globally unique UUID of the email address.
Information about the TOTP-backed Authenticator App factor, if one is present.
Show properties
Show properties
Globally unique UUID that identifies the TOTP instance.
Information about the trusted auth token factor, if one is present.
Show properties
Show properties
The ID of the trusted auth token.
organization_id
The globally unique UUID that identifies the Organization associated with the Session.
organization_slug
The unique URL slug of the Organization associated with the Session.
A list of the roles associated with the Session.
Members may inherit certain roles depending on the factors in their Session.
For example, some roles may only be active if the member logged in from a specific SAML IDP.
The timestamp when the Session was created. Values conform to the RFC 3339 standard and are expressed in UTC, e.g.
2021-12-29T12:33:09Z.The timestamp when the Session was last accessed. Values conform to the RFC 3339 standard and are expressed in UTC, e.g.
2021-12-29T12:33:09Z.The timestamp when the Session expires. Values conform to the RFC 3339 standard and are expressed in UTC, e.g.
2021-12-29T12:33:09Z.The custom claims map for a Session. Claims can be added to a Session during a Sessions authenticate call.
The Member object of the signed-in Member.
Show properties
Show properties
Globally unique UUID that identifies a specific Organization.
Globally unique UUID that identifies a specific Member.
The ID of the Member given by the identity provider.
The email address of the Member.
Whether or not the Member’s email address is verified.
The status of the Member. The possible values are:
pending, invited, active, or deleted.The name of the Member.
An array of registered SAML Connection or OIDC Connection objects the Member has authenticated with.
Show sso_registration properties
Show sso_registration properties
Globally unique UUID that identifies a specific SSO
connection_id for a Member.The unique ID of an SSO Registration.
The ID of the Member given by the identity provider.
An object for storing SSO attributes brought over from the identity provider.
Sets whether the Member is enrolled in MFA.
Show sso_registration properties
Show sso_registration properties
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 and its
auth_methods and allowed_auth_methods fields for more details.Globally unique UUID that identifies a Member’s password.
A list of OAuth registrations for this Member.
Show oauth_registrations properties
Show oauth_registrations properties
Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.
The unique identifier for the User within a given OAuth provider. Also commonly called the sub or “Subject field” in OAuth protocols.
If available, the
profile_picture_url is a URL of the User’s profile picture set in the OAuth identity provider that the User has authenticated with, e.g. Google profile picture.If available, the locale is the Member’s locale set in the OAuth identity provider that the user has authenticated with.
The unique ID of an OAuth registration.
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.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).
Whether or not the Member’s phone number is verified.
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.
An arbitrary JSON object for storing application-specific data or identity-provider-specific data.
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 for complete field behavior details.
Explicit or implicit Roles assigned to this Member, along with details about the role assignment source. See the RBAC guide for more information about role assignment.
Show roles properties
Show roles properties
The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable.Reserved
role_ids that are predefined by Stytch include:stytch_memberstytch_admin
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.
Show sources properties
Show sources properties
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 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 therbac_email_implicit_role_assignmentsargument to the 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 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 thesaml_connection_implicit_role_assignmentsargument to the 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 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.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 thescim_group_implicit_role_assignmentsargument to the Update SCIM connection endpoint.
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 theconnection_idof the SAML connection that granted the assignment.sso_connection_group– will contain theconnection_idof the SAML connection and the name of the group that granted the assignment.scim_connection_group– will contain theconnection_idof the SAML connection and thegroup_idthat granted the assignment.
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. See the RBAC guide for more details on this Role.The date and time the Member was created.
The date and time the Member was last updated.
The Organization object of the Organization the Member has signed into.
Show properties
Show properties
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.The name of the Organization. Must be between 1 and 128 characters in length.
The image URL of the Organization logo.
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.An array of active SAML Connection references or OIDC Connection references.
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 RESTRICTEDCommon domains such as gmail.com are not allowed. See the full list of disallowed common email domains.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 withemail_allowed_domainscan be provisioned upon authentication via Email Magic Link or OAuthNOT_ALLOWED– the default setting, disables JIT provisioning via Email Magic Link and OAuth
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 usedRESTRICTED– only methods that comply withallowed_auth_methodscan be used for authentication. This setting does not apply to Members withis_breakglassset to true
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.The default connection used for SSO when there are multiple active connections.
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 inallowed_oauth_tenantscan JIT provision via tenantNOT_ALLOWED– the default setting, disables JIT provisioning by OAuth Tenant
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”.
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 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.