Configuration for the TurnkeyProvider. This interface extends the TurnkeySDKClientConfig to include additional UI and auth configurations. It is used to initialize the TurnkeyProvider with various options such as colors, dark mode, auth methods, and more.TurnkeyProviderConfig
enables or disables specific authentication methods.
Show methods details
auth.methods.appleOauthEnabled
boolean
auth.methods.discordOauthEnabled
boolean
auth.methods.emailOtpAuthEnabled
boolean
auth.methods.facebookOauthEnabled
boolean
auth.methods.googleOauthEnabled
boolean
auth.methods.passkeyAuthEnabled
boolean
auth.methods.smsOtpAuthEnabled
boolean
auth.methods.walletAuthEnabled
boolean
auth.methods.xOauthEnabled
boolean
auth.oauthConfig
object
configuration for OAuth authentication.
Show oauthConfig details
auth.oauthConfig.appleClientId
string
client ID for Apple OAuth.
auth.oauthConfig.discordClientId
string
client ID for Discord OAuth.
auth.oauthConfig.facebookClientId
string
client ID for Facebook OAuth.
auth.oauthConfig.googleClientId
string
client ID for Google OAuth.
auth.oauthConfig.oauthRedirectUri
string
redirect URI for OAuth.
auth.oauthConfig.openOauthInPage
boolean
whether to open OAuth in the same page. Always true on mobile.
auth.oauthConfig.xClientId
string
client ID for X (formerly Twitter) OAuth.
auth.oauthOrder
"google" | "apple" | "facebook" | "x" | "discord"[]
order of OAuth authentication methods.
auth.otpAlphanumeric
boolean
If otp sent will be alphanumeric. If using the auth proxy, you must configure this setting through the dashboard. Changing this through the TurnkeyProvider will have no effect.
auth.otpLength
string
length of the OTP. If using the auth proxy, you must configure this setting through the dashboard. Changing this through the TurnkeyProvider will have no effect.
auth.sessionExpirationSeconds
string
session expiration time in seconds. If using the auth proxy, you must configure this setting through the dashboard. Changing this through the TurnkeyProvider will have no effect.
auth.verifyWalletOnSignup
boolean
whether to verify the app proof generated by a proxySignup request if the request includes wallet account creation. The end user will see a modal during this process.
