Appearance

Documentation / react-auth / UseSyncJwtBasedAuthStateInput

Interface: UseSyncJwtBasedAuthStateInput ​

Properties ​

enabled? ​

enabled?: boolean

Whether the external JWT authentication system is enabled. This can be used to disable the sync process when the external system is not enabled or otherwise not available.

getExternalJwt ​

getExternalJwt: () => Promise<undefined | string>

A function that returns a JWT token from the external system. If the user is not authenticated, this function should return undefined.

This function should not throw and doing so will result in the user being logged out.

Returns ​

Promise<undefined | string>

onAuthenticated? ​

onAuthenticated?: (event) => void

A callback that is called when the user is authenticated in Privy after syncing with the external system.

Parameters ​

• event: OnAuthenticatedEvent

Returns ​

void

onError? ​

onError?: (error) => void

A callback that is called when an error occurs during the sync process.

Parameters ​

• error: Error

Returns ​

void

onUnauthenticated? ​

onUnauthenticated?: () => void

A callback that is called when the user is unauthenticated in Privy after syncing with the external system.

Returns ​

void

subscribe ​

subscribe: SubscribeToJwtAuth

This callback is used by Privy for subscribing to changes in the state of the external authentication system. It should return a function that can be called to unsubscribe so as to avoid stale listeners.

The passed callback should be wrapped in a useCallback to avoid re-subscribing too often.

Consider using useSubscribeToJwtAuthWithFlag if the external system offers an isAuthenticated flag instead of direct listeners.

Example ​

ts
subscribe: useCallback((onAuthStateChange) => {
  SomeAuthManager.addEventListener('session', onAuthStateChange);
  return () => {
    SomeAuthManager.removeEventListener('session', onAuthStateChange);
  };
}, [])