storeSession() - Turnkey

Stores a session token and updates the session associated with the specified session key, or by default the active session.

This function parses and stores a signed JWT session token in local storage, associating it with the given session key.
If a sessionKey is provided, the session will be stored under that key; otherwise, it will use the default session key.
If a session already exists for the session key, its associated key pair will be deleted before storing the new session.
After storing the session, any unused key pairs are automatically cleared from storage.
Ensures that session management is consistent and prevents orphaned key pairs.

Package: core

Defined in: core.ts:3778

params

object

required

Show params details

params.sessionKey

string

session key to store the session under (defaults to the default session key).

params.sessionToken

string

required

JWT session token to store.

A successful response returns the following fields:

returns

void

required

A promise that resolves when the session is successfully stored.