On Change Session - Stytch Docs

import { useEffect, useState } from 'react';
import { useStytch } from '@stytch/nextjs';

export const SessionDisplay = () => {
  const stytch = useStytch();
  const [session, setSession] = useState(null);

  useEffect(() => {
    const unsubscribe = stytch.session.onChange((session) => {
      setSession(session);
    });

    return unsubscribe;
  }, [stytch]);

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

import { useEffect, useState } from 'react';
import { useStytch } from '@stytch/nextjs';

export const SessionDisplay = () => {
  const stytch = useStytch();
  const [session, setSession] = useState(null);

  useEffect(() => {
    const unsubscribe = stytch.session.onChange((session) => {
      setSession(session);
    });

    return unsubscribe;
  }, [stytch]);

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

import { useEffect, useState } from 'react';
import { useStytch } from '@stytch/nextjs';

export const SessionDisplay = () => {
  const stytch = useStytch();
  const [session, setSession] = useState(null);

  useEffect(() => {
    const unsubscribe = stytch.session.onChange((session) => {
      setSession(session);
    });

    return unsubscribe;
  }, [stytch]);

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

The Stytch SDK caches the Session of the logged-in . Use the session.onChange method to listen for and react to changes to the Session object.

Parameters

callback

function

The callback function to call when the session changes. The first parameter is the updated Session object.

Show parameters

session

object

The updated Session object.

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.

Return value

unsubscribe

function

The function to call to unsubscribe from the Session change event.

⌘I

​Parameters

​Return value

Parameters

Return value