Session object

function attemptFirstFactorVerification(attemptFactor: SessionVerifyAttemptFirstFactorParams): Promise<SessionVerificationResource>

type SessionVerifyAttemptFirstFactorParams =
  | EmailCodeAttempt
  | PhoneCodeAttempt
  | PasswordAttempt
  | PasskeyAttempt

type EmailCodeAttempt = {
  strategy: 'email_code'
  code: string
}

type PhoneCodeAttempt = {
  strategy: 'phone_code'
  code: string
}

type PasswordAttempt = {
  strategy: 'password'
  password: string
}

type PasskeyAttempt = {
  strategy: 'passkey'
  publicKeyCredential: PublicKeyCredentialWithAuthenticatorAssertionResponse
}

function attemptSecondFactorVerification(params: SessionVerifyAttemptSecondFactorParams): Promise<SessionVerificationResource>

type SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt

type PhoneCodeAttempt = {
  strategy: 'phone_code'
  code: string
}

type TOTPAttempt = {
  strategy: 'totp'
  code: string
}

type BackupCodeAttempt = {
  strategy: 'backup_code'
  code: string
}

function checkAuthorization(isAuthorizedParams: CheckAuthorizationParams): boolean

type WithReverification<T> = T & {
  /**
   * The reverification configuration to check for. This feature is currently in public beta. **It is not recommended for production use.** See https://clerk.com/docs/reference/backend/types/auth-object#reverification-config for more information.
   */
  reverification?: ReverificationConfig
}

type CheckAuthorizationParams = WithReverification<
  | {
      /**
       * The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
       */
      role: OrganizationCustomRoleKey
      /**
       * The [Permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
       */
      permission?: never
      /**
       * The [Feature](https://clerk.com/docs/guides/secure/features) to check for.
       */
      feature?: never
      /**
       * The [Plan](https://clerk.com/docs/guides/billing/overview) to check for.
       */
      plan?: never
    }
  | {
      role?: never
      permission: OrganizationPermissionKey
      feature?: never
      plan?: never
    }
  | {
      role?: never
      permission?: never
      feature: Autocomplete<`user:${string}` | `org:${string}`>
      plan?: never
    }
  | {
      role?: never
      permission?: never
      feature?: never
      plan: Autocomplete<`user:${string}` | `org:${string}`>
    }
  | { role?: never; permission?: never; feature?: never; plan?: never }
>

function clearCache(): void

function end(): Promise<SessionResource>

function getToken(options?: GetTokenOptions): Promise<null | string>

function prepareFirstFactorVerification(factor: SessionVerifyPrepareFirstFactorParams): Promise<SessionVerificationResource>

type SessionVerifyPrepareFirstFactorParams =
  | EmailCodeConfig
  | PhoneCodeConfig
  | PassKeyConfig
  | Omit<EnterpriseSSOConfig, 'actionCompleteRedirectUrl'>

type EmailCodeConfig = {
  /**
   * The strategy type.
   */
  strategy: 'email_code'
  /**
   * The ID of the email address used for the email code factor.
   */
  emailAddressId: string
  /**
   * Indicates whether the email address is set as the primary email address, as multiple can be added to a user's profile.
   */
  primary?: boolean
}

type PhoneCodeConfig = {
  /**
   * The strategy type.
   */
  strategy: 'phone_code'
  /**
   * The ID of the phone number used for the phone code factor.
   */
  phoneNumberId: string
  /**
   * Indicates whether the phone number is set as the primary phone number, as multiple can be added to a user's profile.
   */
  primary?: boolean
  /**
   * Indicates whether the phone number is set as the default identifier.
   */
  default?: boolean
  /**
   * The channel used for the phone code factor.
   */
  channel?: 'sms' | 'whatsapp'
}

type PassKeyConfig = {
  /**
   * The strategy type.
   */
  strategy: 'passkey'
}

type EnterpriseSSOConfig = {
  /**
   * The strategy type.
   */
  strategy: 'enterprise_sso'
  /**
   * The ID of the enterprise connection.
   * @experimental
   */
  enterpriseConnectionId?: string
  /**
   * The name of the enterprise connection.
   * @experimental
   */
  enterpriseConnectionName?: string
  /**
   * The URL to redirect to after the OAuth flow is completed.
   */
  redirectUrl: string
  /**
   * The OIDC prompt parameter to use for the OAuth flow.
   */
  oidcPrompt?: string
  /**
   * The ID of the email address used for the enterprise SSO factor.
   * @experimental
   */
  emailAddressId?: string
}

function prepareSecondFactorVerification(params: PhoneCodeSecondFactorConfig): Promise<SessionVerificationResource>

type PhoneCodeSecondFactorConfig = {
  /**
   * The strategy type.
   */
  strategy: 'phone_code'
  /**
   * The ID of the phone number used for the phone code second factor.
   */
  phoneNumberId?: string
}

function remove(): Promise<SessionResource>

function startVerification(params: SessionVerifyCreateParams): Promise<SessionVerificationResource>

function touch(params?: SessionTouchParams): Promise<SessionResource>

function verifyWithPasskey(): Promise<SessionVerificationResource>