Skip to main content

​
Type definition

Below is the type definition for the UseAuthParams type. This is the type definition for the parameters you pass to the useAuth hook. The type varies depending on whether auto-registration is enabled.

​
With auto-registration (autoRegister: true)

type UseAuthParams = {
  partnerId: string; // Required, replace with your actual partner ID
  partnerToken: string; // Required, replace with your actual partner token
  autoRegister?: true; // Default is true
  loginOnMount?: boolean; // Optional, set to true to sign in automatically when the component mounts
  providerId?: string; // Optional, replace with your actual provider ID
  providerName: string; // Required for auto-registration
  providerOrgId: string; // Required for auto-registration
  providerSpecialty?: string; // Required for auto-registration
};

​
Without auto-registration (autoRegister: false)

type UseAuthParams = {
  partnerId: string; // Required, replace with your actual partner ID
  partnerToken: string; // Required, replace with your actual partner token
  autoRegister?: false; // Default is false
  loginOnMount?: boolean; // Optional, set to true to sign in automatically when the component mounts
  providerId?: string; // Optional, replace with your actual provider ID
};

​
Related content

useAuth hook

The hook for managing user authentication.
Last modified on April 1, 2026