connectTo Function ReferenceconnectTo<T extends WALLET_CONNECTOR_TYPE>(
connector: T,
params?: LoginParamMap[T]
): Promise<IProvider | null>;
export type LoginParamMap = {
[WALLET_CONNECTORS.AUTH]: Partial<AuthLoginParams>;
...
};
AuthLoginParams| Parameter | Description |
|---|---|
loginHint? | Helps pass over the login hint to the auth provider. This is used especially for email_passwordless and sms_passwordless logins. |
idToken? | Pass over the JWT ID token directly to Web3Auth for JWT authentication. |
authConnection? | The auth provider to use for login (for example, "google", "facebook"). |
authConnectionId? | The ID configured in your Embedded Wallets dashboard for the connection. |
groupedAuthConnectionId? | The grouped Auth Connection ID to be used for login. |
extraLoginOptions? | Custom OAuth options (for example, login_hint, domain). |
export type AuthLoginParams = LoginParams & {
loginHint?: string;
idToken?: string;
};
export type LoginParams = {
/**
* Any custom state you wish to pass along. This will be returned to you post redirect.
* Use this to store data that you want to be available to the dapp after login.
*/
appState?: string;
/**
* The auth connection to be used for login.
*/
authConnection: AUTH_CONNECTION_TYPE | CUSTOM_AUTH_CONNECTION_TYPE;
/**
* The auth connection id to be used for login.
*/
authConnectionId?: string;
/**
* The grouped auth connection id to be used for login.
*/
groupedAuthConnectionId?: string;
/**
* You can set the `mfaLevel` to customize when mfa screen should be shown to user.
* It currently accepts 4 values:-
* - `'default'`: Setting mfa level to `default` will present mfa screen to user on every third login.
* - `'optional'`: Setting mfa level to `default` will present mfa screen to user on every login but user can skip it.
* - `'mandatory'`: Setting mfa level to `mandatory` will make it mandatory for user to setup mfa after login.
* - `'none'`: Setting mfa level to `none` will make the user skip the mfa setup screen
*
* Defaults to `none`
* @defaultValue `none`
*/
mfaLevel?: MfaLevelType;
/**
* This option is for internal use only in torus wallet and has no effect
* on user's login on other dapps.
*
* Defaults to false
* @defaultValue false
* @internal
*/
getWalletKey?: boolean;
/**
* extraLoginOptions can be used to pass standard oauth login options to
* loginProvider.
*
* For ex: you will have to pass `login_hint` as user's email and `domain`
* as your app domain in `extraLoginOptions` while using `email_passwordless`
* loginProvider
*/
extraLoginOptions?: ExtraLoginOptions;
/**
* Custom Logins can get a dapp share returned to them post successful login.
* This is useful if the dapps want to use this share to allow users to login seamlessly
* dappShare is a 24 word seed phrase
*/
dappShare?: string;
/**
* This curve will be used to determine the public key encoded in the jwt token which returned in
* `getUserInfo` function after user login.
* You can use that public key from jwt token as a unique user identifier in your backend.
*
* - `'secp256k1'`: secp256k1 based pub key is added as a wallet public key in jwt token to use.
* - `'ed25519'`: ed25519 based pub key is added as a wallet public key in jwt token to use.
*
* Note: This parameter won't change format of private key returned by auth. Private key returned
* by auth is always `secp256k1`.
*
*
* @defaultValue secp256k1
*/
curve?: SUPPORTED_KEY_CURVES_TYPE;
/**
* Allows the dapp to set a custom redirect url for the manage mfa flow.
*
*/
dappUrl?: string;
};
export const AUTH_CONNECTION = {
GOOGLE: 'google',
TWITTER: 'twitter',
FACEBOOK: 'facebook',
DISCORD: 'discord',
FARCASTER: 'farcaster',
APPLE: 'apple',
GITHUB: 'github',
REDDIT: 'reddit',
LINE: 'line',
KAKAO: 'kakao',
LINKEDIN: 'linkedin',
TWITCH: 'twitch',
TELEGRAM: 'telegram',
WECHAT: 'wechat',
EMAIL_PASSWORDLESS: 'email_passwordless',
SMS_PASSWORDLESS: 'sms_passwordless',
CUSTOM: 'custom',
}
extraLoginOptions)For custom integrations (like Auth0, AWS Cognito), you can provide additional options:
| Parameter | Description |
|---|---|
isUserIdCaseSensitive | Whether the user ID field is case sensitive [Default: true] |
domain | Auth provider domain (for example, "example.auth0.com") |
client_id | Client ID from your auth provider |
scope | OAuth scopes (for example, "email profile openid") |
response_type | Response type for OAuth flow |
login_hint | Pre-fill user identifier |
export type ExtraLoginOptions = Auth0ClientOptions;
export interface Auth0ClientOptions extends BaseLoginOptions {
/**
* Your Auth0 account domain such as `'example.auth0.com'`,
* `'example.eu.auth0.com'` or , `'example.mycompany.com'`
* (when using [custom domains](https://auth0.com/docs/custom-domains))
*/
domain?: string;
/**
* The Client ID found on your Application settings page
*/
client_id?: string;
/**
* The field in jwt token which maps to user id
*/
userIdField?: string;
/**
* Whether the user id field is case sensitive
* @defaultValue true
*/
isUserIdCaseSensitive?: boolean;
id_token?: string;
access_token?: string;
/**
* The route for user info endpoint. This will be padded to domain
* @defaultValue userinfo
* */
user_info_route?: string;
/**
* The flow type for email_passwordless login
*/
flow_type?: EMAIL_FLOW_TYPE;
}