Appearance

Documentation / react-auth / UseSubscribeToJwtAuthWithFlagInput

Interface: UseSubscribeToJwtAuthWithFlagInput ​

Extends ​

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.

Inherited from ​

Omit.enabled

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>

Inherited from ​

Omit.getExternalJwt

isAuthenticated? ​

isAuthenticated?: boolean

A flag indicating whether the user is authenticated in the external JWT-based authentication system.

Changes to this value in any direction will trigger a re-synchronization of the Privy JWT authentication state.

isLoading? ​

isLoading?: boolean

A flag indicating whether the external JWT-based authentication system is loading or otherwise refreshing its state.

Changes to this value in any direction will trigger a re-synchronization of the Privy JWT authentication state.

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

Inherited from ​

Omit.onAuthenticated

onError? ​

onError?: (error) => void

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

Parameters ​

• error: Error

Returns ​

void

Inherited from ​

Omit.onError

onUnauthenticated? ​

onUnauthenticated?: () => void

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

Returns ​

void

Inherited from ​

Omit.onUnauthenticated