Skip to main content
Example
export interface TransactionMembers {
  state: string;
  locale: string;
  countryCode: CountryCode['code'] | null;
  countryPrefix: CountryCode['prefix'] | null;
  connectionStrategy: string | null;
  hasErrors: boolean;
  errors: Error[] | null;
  currentConnection: Connection | null;
  alternateConnections: (Connection | EnterpriseConnection)[] | null;
}

Properties

alternateConnections
connectionStrategy
string
countryCode
string
countryPrefix
string
currentConnection
errors
hasErrors
boolean
locale
string
state
string

Connection

export interface Connection {
  name: string;
  strategy: string;
  metadata?: Record<string, string>;
}

Properties

metadata?
Record<string, string>
name
string
strategy
string

EnterpriseConnection

export interface EnterpriseConnection extends Connection {
  options: {
    iconUrl?: string;
    displayName?: string;
    showAsButton: boolean;
  };
}

Properties

metadata?
Record<string, string>
name
string
options
object
strategy
string

DBConnection

Example
export interface DBConnection extends Connection {
  options: {
    signup_enabled: boolean;
    flexible_identifiers_active?: boolean;
    forgot_password_enabled: boolean;
    username_required?: boolean;
    validation?: {
      username: {
        max_length: number;
        min_length: number;
      };
    };
    attributes?: {
      email?: {
        signup_status: string;
        identifier_active: boolean;
      };
      username?: {
        signup_status: string;
        identifier_active: boolean;
        validation?: {
          max_length: number;
          min_length: number;
          allowed_types: {
            email: boolean;
            phone_number: boolean;
          };
        };
      };
      phone?: {
        signup_status: string;
        identifier_active: boolean;
      };
    };
    authentication_methods: {
      password: {
        enabled: boolean;
        policy: string;
        min_length: number;
        password_security_info?: PasswordComplexityRule[];
      };
      passkey: {
        enabled: boolean;
      };
    };
  };
}

Properties

options
object

PasswordlessConnection

Example
export interface PasswordlessConnection extends Connection {
  options: {
    signup_enabled: boolean;
  };
}

Properties

options
object

SocialConnection

Example
export interface SocialConnection extends Connection {}

PasswordPolicy

export interface PasswordPolicy {
  enabled?: boolean;
  minLength?: number;
  policy: 'none' | 'low' | 'fair' | 'good' | 'excellent';
  passwordSecurityInfo?: PasswordComplexityRule[];
}

Properties

enabled?
boolean
minLength?
number
passwordSecurityInfo?
policy
"none" | "low" | "fair" | "good" | "excellent"