useStytchSession - Stytch Docs

import { useStytchSession } from '@stytch/react';

export const SessionInfo = () => {
  const { session } = useStytchSession();

  return session ? <p>Session ID: {session.session_id}</p> : <p>No active session</p>;
};

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

import { useStytchSession } from '@stytch/react';

export const SessionInfo = () => {
  const { session } = useStytchSession();

  return session ? <p>Session ID: {session.session_id}</p> : <p>No active session</p>;
};

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

import { useStytchSession } from '@stytch/react';

export const SessionInfo = () => {
  const { session } = useStytchSession();

  return session ? <p>Session ID: {session.session_id}</p> : <p>No active session</p>;
};

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

To get the active Session for the currently signed in User, use the useStytchSession hook. If no User is signed in, the returned value will be null. In non-React environments, use the session.getSync method to get the Session.

Return Value

session

object | null

The current Session.

Show properties

session_id

string

A unique identifier for a specific Session.

user_id

string

The unique ID of the affected User.

authentication_factors

array[objects]

An array of different authentication factors that comprise a Session.

started_at

string

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.

last_accessed_at

string

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.

expires_at

string

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.

attributes

object

Provided attributes help with fraud detection.

Show properties

ip_address

string

The IP address of the user.

user_agent

string

The user agent of the User.

custom_claims

map

The custom claims map for a Session. Claims can be added to a session during a Sessions authenticate call.

roles

array[string]

A list of the roles associated with the session.

fromCache

boolean

Whether the Session data is from persistent storage.

⌘I

Documentation Index

​Return Value

Return Value