@teamhanko/hanko-frontend-sdk/dist/lib/flow-api/types/payload.d.ts

A package for simplifying UI integration with the Hanko API. It is meant for use in browsers only.

import { CredentialCreationOptionsJSON, CredentialRequestOptionsJSON } from "@github/webauthn-json/src/webauthn-json/basic/json";
import { Claims } from "../../Dto";
export interface PasscodeConfirmationPayload {
    readonly passcode_resent: boolean;
    readonly resend_after: number;
}
export interface LoginPasskeyPayload {
    readonly request_options: CredentialRequestOptionsJSON;
}
export interface MFAOTPSecretCreationPayload {
    readonly otp_secret: string;
    readonly otp_image_source: string;
}
export interface OnboardingVerifyPasskeyAttestationPayload {
    readonly creation_options: CredentialCreationOptionsJSON;
}
export interface LoginInitPayload {
    readonly request_options?: CredentialRequestOptionsJSON;
}
export interface WebauthnCredential {
    readonly id: string;
    readonly name?: string;
    readonly public_key: string;
    readonly attestation_type: string;
    readonly aaguid: string;
    readonly last_used_at?: string;
    readonly created_at: string;
    readonly transports: string;
    readonly backup_eligible: string;
    readonly backup_state: string;
}
export interface Username {
    id: string;
    username: string;
    created_at: string;
    updated_at: string;
}
export interface Identity {
    readonly id: string;
    readonly provider: string;
    readonly identity_id?: string;
}
export interface Email {
    readonly id: string;
    readonly address: string;
    readonly is_verified: boolean;
    readonly is_primary: boolean;
    readonly identities?: Identity[];
}
export interface MFAConfig {
    readonly auth_app_set_up: boolean;
    readonly totp_enabled: boolean;
    readonly security_keys_enabled: boolean;
}
export type UserMetadata<PublicMetadata extends Record<string, any> = {}, UnsafeMetadata extends Record<string, any> = {}> = {
    public_metadata?: PublicMetadata;
    unsafe_metadata?: UnsafeMetadata;
};
export interface User {
    readonly user_id: string;
    readonly passkeys?: WebauthnCredential[];
    readonly security_keys?: WebauthnCredential[];
    readonly mfa_config?: MFAConfig;
    readonly emails?: Email[];
    readonly username?: Username;
    readonly metadata?: UserMetadata;
    readonly identities?: Identity[];
    readonly created_at: string;
    readonly updated_at: string;
    readonly name?: string;
    readonly given_name?: string;
    readonly family_name?: string;
    readonly picture?: string;
}
export interface Session {
    readonly id: string;
    readonly user_agent?: string;
    readonly user_agent_raw?: string;
    readonly ip_address?: string;
    readonly created_at: string;
    readonly last_used: string;
    readonly current: boolean;
}
export interface ProfilePayload {
    readonly user: User;
    readonly sessions?: Session[];
}
export type LoginMethod = "password" | "passkey" | "passcode" | "third_party";
export type MFAMethod = "totp" | "security_key";
export interface LastLogin {
    readonly login_method: LoginMethod;
    readonly mfa_method?: MFAMethod;
    readonly third_party_provider?: string;
}
export interface SuccessPayload {
    readonly user: User;
    readonly last_login?: LastLogin;
    readonly claims: Claims;
}
export interface ThirdPartyPayload {
    readonly redirect_url: string;
}