Skip to content

Documentation / react-auth / PrivyProviderProps

Interface: PrivyProviderProps

Properties to initialize the PrivyProvider.

Properties

appId

appId: string

Your Privy App ID, which can be retrieved from the Privy dashboard.


clientId?

clientId?: string

Your Privy App Client ID, which can be retrieved from the Privy dashboard.


config?

config?: PrivyClientConfig

Client configuration options. Values here will override their server-configuration counterparts.


createPrivyWalletOnLogin?

createPrivyWalletOnLogin?: boolean

Deprecated

use config.embeddedWallets.createOnLogin instead


onSuccess?

onSuccess?: (user, isNewUser) => void

An optional callback that will execute once a login call successfully completes.

Within this callback, you can access:

  • the user object corresponding to the authenticated user
  • an isNewUser boolean flag indicating if this is the user's first time logging in to your app

Parameters

user: User

isNewUser: boolean

Returns

void