useStytchMember Hook - Stytch Docs

import { useStytchMember } from '@stytch/nextjs/b2b';

export const Home = () => {
  const { member, isInitialized } = useStytchMember();

  if (!isInitialized) {
    return <p>Loading...</p>;
  }

  return member ? <p>Welcome, {member.name}</p> : <p>Log in to continue!</p>;
};

{
  "member": { ... },
  "isInitialized": true,
  "fromCache": false
}

{
  "member": null,
  "isInitialized": false,
  "fromCache": false
}

{
  "member": null,
  "isInitialized": true,
  "fromCache": false
}

import { useStytchMember } from '@stytch/nextjs/b2b';

export const Home = () => {
  const { member, isInitialized } = useStytchMember();

  if (!isInitialized) {
    return <p>Loading...</p>;
  }

  return member ? <p>Welcome, {member.name}</p> : <p>Log in to continue!</p>;
};

{
  "member": { ... },
  "isInitialized": true,
  "fromCache": false
}

{
  "member": null,
  "isInitialized": false,
  "fromCache": false
}

{
  "member": null,
  "isInitialized": true,
  "fromCache": false
}

import { useStytchMember } from '@stytch/nextjs/b2b';

export const Home = () => {
  const { member, isInitialized } = useStytchMember();

  if (!isInitialized) {
    return <p>Loading...</p>;
  }

  return member ? <p>Welcome, {member.name}</p> : <p>Log in to continue!</p>;
};

{
  "member": { ... },
  "isInitialized": true,
  "fromCache": false
}

{
  "member": null,
  "isInitialized": false,
  "fromCache": false
}

{
  "member": null,
  "isInitialized": true,
  "fromCache": false
}

To get the currently signed in , use the useStytchMember hook. If the user is not signed in, the member object will be null. In non-React environments, use the self.getSync method to get the Member.

Return Value

object | null

The current Member.

Show properties

string

Globally unique UUID that identifies a specific Organization.

string

Globally unique UUID that identifies a specific Member.

string

The ID of the Member given by the identity provider.

string

The email address of the Member.

boolean

Whether or not the Member’s email address is verified.

string

The status of the Member. The possible values are: pending, invited, active, or deleted.

string

The name of the Member.

object[]

An array of registered SAML Connection or OIDC Connection objects the Member has authenticated with.

Show sso_registration properties

string

Globally unique UUID that identifies a specific SSO connection_id for a Member.

string

The unique ID of an SSO Registration.

string

The ID of the Member given by the identity provider.

object

An object for storing SSO attributes brought over from the identity provider.

object

Sets whether the Member is enrolled in MFA.

Show sso_registration properties

string

The id of the SCIM Connection.

string

The unique ID of a SCIM Registration.

string

The ID of the Member given by the identity provider.

object

An object for storing SCIM attributes brought over from the identity provider.

boolean

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.

string

Globally unique UUID that identifies a Member’s password.

object[]

A list of OAuth registrations for this Member.

Show oauth_registrations properties

string

Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc.

string

The unique identifier for the User within a given OAuth provider. Also commonly called the sub or “Subject field” in OAuth protocols.

string

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.

string

If available, the locale is the Member’s locale set in the OAuth identity provider that the user has authenticated with.

string

The unique ID of an OAuth registration.

boolean

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.

string

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).

boolean

Whether or not the Member’s phone number is verified.

object[]

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.

Show properties

string

The globally unique UUID of a Member’s email.

string

The email address of the Member.

object

An arbitrary JSON object for storing application-specific data or identity-provider-specific data.

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 for complete field behavior details.

object[]

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

string

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_member
stytch_admin

Check out the guide on Stytch default Roles for a more detailed explanation.

object[]

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

string

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 the rbac_email_implicit_role_assignments argument 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 the saml_connection_implicit_role_assignments argument 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 the scim_group_implicit_role_assignments argument to the Update SCIM connection endpoint.

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.

boolean

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.

string

The date and time the Member was created.

string

The date and time the Member was last updated.

boolean

Whether the Session data is from persistent storage.

⌘I

​Return Value

Return Value