AuthParams
1 type AuthParams = 2 | { 3 email: string; 4 emailMode?: "magicLink" | "otp"; 5 multiFactors?: VerifyMfaParams[]; 6 redirectParams?: URLSearchParams; 7 type: "email"; 8 } 9 | { 10 bundle: string; 11 isNewUser?: boolean; 12 orgId?: string; 13 type: "email"; 14 } 15 | { 16 phone: string; 17 type: "sms"; 18 } 19 | { 20 creationOpts?: CredentialCreationOptionOverrides; 21 email: string; 22 type: "passkey"; 23 } 24 | { 25 createNew: false; 26 type: "passkey"; 27 } 28 | { 29 createNew: true; 30 creationOpts?: CredentialCreationOptionOverrides; 31 type: "passkey"; 32 username: string; 33 } 34 | (object & OauthProviderConfig & OauthRedirectConfig) 35 | { 36 accessToken?: string; 37 bundle: string; 38 idToken: string; 39 isNewUser?: boolean; 40 orgId: string; 41 type: "oauthReturn"; 42 } 43 | { 44 authProviderId?: string; 45 jwt: string; 46 type: "custom-jwt"; 47 } 48 | { 49 multiFactors?: VerifyMfaParams[]; 50 otpCode: string; 51 type: "otp"; 52 } 53 | (object & AccessKeyAuthParams);
Defined in: account-kit/signer/src/signer.ts:19
Type Declaration
1 { 2 email: string; 3 emailMode?: "magicLink" | "otp"; 4 multiFactors?: VerifyMfaParams[]; 5 redirectParams?: URLSearchParams; 6 type: "email"; 7 }
Name | Type | Description |
---|---|---|
|
| ‐ |
|
| Deprecated This option will be overriden by dashboard settings. Please use the dashboard settings instead. This option will be removed in a future release. |
| ‐ | |
|
| ‐ |
|
| ‐ |
1 { 2 bundle: string; 3 isNewUser?: boolean; 4 orgId?: string; 5 type: "email"; 6 }
Name | Type |
---|---|
|
|
|
|
|
|
|
|
1 { 2 phone: string; 3 type: "sms"; 4 }
Name | Type |
---|---|
|
|
|
|
1 { 2 creationOpts?: CredentialCreationOptionOverrides; 3 email: string; 4 type: "passkey"; 5 }
Name | Type |
---|---|
| |
|
|
|
|
1 { 2 createNew: false; 3 type: "passkey"; 4 }
Name | Type |
---|---|
|
|
|
|
1 { 2 createNew: true; 3 creationOpts?: CredentialCreationOptionOverrides; 4 type: "passkey"; 5 username: string; 6 }
Name | Type |
---|---|
|
|
| |
|
|
|
|
object
& OauthProviderConfig
& OauthRedirectConfig
1 { 2 accessToken?: string; 3 bundle: string; 4 idToken: string; 5 isNewUser?: boolean; 6 orgId: string; 7 type: "oauthReturn"; 8 }
Name | Type |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
1 { 2 authProviderId?: string; 3 jwt: string; 4 type: "custom-jwt"; 5 }
Name | Type |
---|---|
|
|
|
|
|
|
1 { 2 multiFactors?: VerifyMfaParams[]; 3 otpCode: string; 4 type: "otp"; 5 }
Name | Type |
---|---|
| |
|
|
|
|
object
& AccessKeyAuthParams