AuthParams

type AuthParams =
  | {
      email: string;
      emailMode?: "magicLink" | "otp";
      multiFactors?: VerifyMfaParams[];
      redirectParams?: URLSearchParams;
      type: "email";
    }
  | {
      bundle: string;
      isNewUser?: boolean;
      orgId?: string;
      type: "email";
    }
  | {
      phone: string;
      type: "sms";
    }
  | {
      creationOpts?: CredentialCreationOptionOverrides;
      email: string;
      type: "passkey";
    }
  | {
      createNew: false;
      type: "passkey";
    }
  | {
      createNew: true;
      creationOpts?: CredentialCreationOptionOverrides;
      type: "passkey";
      username: string;
    }
  | (object & OauthProviderConfig & OauthRedirectConfig)
  | {
      accessToken?: string;
      bundle: string;
      idToken: string;
      isNewUser?: boolean;
      orgId: string;
      type: "oauthReturn";
    }
  | {
      authProviderId?: string;
      jwt: string;
      type: "custom-jwt";
    }
  | {
      multiFactors?: VerifyMfaParams[];
      otpCode: string;
      type: "otp";
    }
  | (object & AccessKeyAuthParams);

Defined in: account-kit/signer/src/signer.ts:19

{
  email: string;
  emailMode?: "magicLink" | "otp";
  multiFactors?: VerifyMfaParams[];
  redirectParams?: URLSearchParams;
  type: "email";
}

Name	Type	Description
`email`	`string`	‐
`emailMode?`	`"magicLink"` \| `"otp"`	Deprecated This option will be overriden by dashboard settings. Please use the dashboard settings instead. This option will be removed in a future release.
`multiFactors?`	`VerifyMfaParams`[]	‐
`redirectParams?`	`URLSearchParams`	‐
`type`	`"email"`	‐

{
  bundle: string;
  isNewUser?: boolean;
  orgId?: string;
  type: "email";
}

Name	Type
`bundle`	`string`
`isNewUser?`	`boolean`
`orgId?`	`string`
`type`	`"email"`

{
  phone: string;
  type: "sms";
}

Name	Type
`phone`	`string`
`type`	`"sms"`

{
  creationOpts?: CredentialCreationOptionOverrides;
  email: string;
  type: "passkey";
}

Name	Type
`creationOpts?`	`CredentialCreationOptionOverrides`
`email`	`string`
`type`	`"passkey"`

{
  createNew: false;
  type: "passkey";
}

Name	Type
`createNew`	`false`
`type`	`"passkey"`

{
  createNew: true;
  creationOpts?: CredentialCreationOptionOverrides;
  type: "passkey";
  username: string;
}

Name	Type
`createNew`	`true`
`creationOpts?`	`CredentialCreationOptionOverrides`
`type`	`"passkey"`
`username`	`string`

object & OauthProviderConfig & OauthRedirectConfig

{
  accessToken?: string;
  bundle: string;
  idToken: string;
  isNewUser?: boolean;
  orgId: string;
  type: "oauthReturn";
}

Name	Type
`accessToken?`	`string`
`bundle`	`string`
`idToken`	`string`
`isNewUser?`	`boolean`
`orgId`	`string`
`type`	`"oauthReturn"`

{
  authProviderId?: string;
  jwt: string;
  type: "custom-jwt";
}

Name	Type
`authProviderId?`	`string`
`jwt`	`string`
`type`	`"custom-jwt"`

{
  multiFactors?: VerifyMfaParams[];
  otpCode: string;
  type: "otp";
}

Name	Type
`multiFactors?`	`VerifyMfaParams`[]
`otpCode`	`string`
`type`	`"otp"`

object & AccessKeyAuthParams