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
parameters for creating a sub-organization for each authentication method.
Show createSuborgParams details
auth.createSuborgParams.emailOtpAuth
CreateSubOrgParams
parameters for email OTP authentication.
auth.createSuborgParams.oauth
CreateSubOrgParams
parameters for OAuth authentication.
auth.createSuborgParams.passkeyAuth
CreateSubOrgParams & object
parameters for passkey authentication.
auth.createSuborgParams.smsOtpAuth
CreateSubOrgParams
parameters for SMS OTP authentication.
auth.oauth
object
OAuth settings per provider
Show oauth details
auth.oauth.apple
OauthProviderConfig
auth.oauth.appScheme
string
application deep link scheme used to complete OAuth in React Native (e.g., “myapp”).
auth.oauth.discord
OauthProviderConfig
auth.oauth.facebook
OauthProviderConfig
auth.oauth.google
OauthProviderConfig
provider enablement/configuration (boolean enables; object configures and enables)
auth.oauth.redirectUri
string
shared default redirect URI for OAuth providers
auth.oauth.x
OauthProviderConfig
auth.otp
object
one-time password (OTP) settings and enablement
Show otp details
auth.otp.alphanumeric
boolean
OTP alphanumeric mode (proxy controlled if using auth proxy)
auth.otp.email
boolean
enable email OTP
auth.otp.length
string
OTP length (proxy controlled if using auth proxy)
auth.otp.sms
boolean
enable SMS OTP
auth.passkey
boolean | object
passkey enablement and options
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.
