Interface AmplifyOutputsAuthProperties

interface AmplifyOutputsAuthProperties {
    authentication_flow_type?: string;
    aws_region: string;
    groups?: Partial<Record<string, UserGroupPrecedence>>[];
    identity_pool_id?: string;
    mfa_configuration?: string;
    mfa_methods?: string[];
    oauth?: {
        domain: string;
        identity_providers: string[];
        redirect_sign_in_uri: string[];
        redirect_sign_out_uri: string[];
        response_type: string;
        scopes: string[];
    };
    password_policy?: {
        min_length: number;
        require_lowercase: boolean;
        require_numbers: boolean;
        require_symbols: boolean;
        require_uppercase: boolean;
    };
    passwordless?: {
        email_otp_enabled?: boolean;
        preferred_challenge?: string;
        sms_otp_enabled?: boolean;
        web_authn?: {
            relying_party_id?: string;
            user_verification?: string;
        };
    };
    standard_required_attributes?: string[];
    unauthenticated_identities_enabled?: boolean;
    user_pool_client_id: string;
    user_pool_id: string;
    user_verification_types?: string[];
    username_attributes?: string[];
}

Properties

authentication_flow_type? aws_region groups? identity_pool_id? mfa_configuration? mfa_methods? oauth? password_policy? passwordless? standard_required_attributes? unauthenticated_identities_enabled? user_pool_client_id user_pool_id user_verification_types? username_attributes?

Properties

Optional authentication_flow_type

authentication_flow_type?: string

aws_region

aws_region: string

Optional groups

groups?: Partial<Record<string, UserGroupPrecedence>>[]

Optional identity_pool_id

identity_pool_id?: string

Optional mfa_configuration

mfa_configuration?: string

Optional mfa_methods

mfa_methods?: string[]

Optional oauth

oauth?: {
    domain: string;
    identity_providers: string[];
    redirect_sign_in_uri: string[];
    redirect_sign_out_uri: string[];
    response_type: string;
    scopes: string[];
}

Type declaration

  • domain: string
  • identity_providers: string[]
  • redirect_sign_in_uri: string[]
  • redirect_sign_out_uri: string[]
  • response_type: string
  • scopes: string[]

Optional password_policy

password_policy?: {
    min_length: number;
    require_lowercase: boolean;
    require_numbers: boolean;
    require_symbols: boolean;
    require_uppercase: boolean;
}

Type declaration

  • min_length: number
  • require_lowercase: boolean
  • require_numbers: boolean
  • require_symbols: boolean
  • require_uppercase: boolean

Optional passwordless

passwordless?: {
    email_otp_enabled?: boolean;
    preferred_challenge?: string;
    sms_otp_enabled?: boolean;
    web_authn?: {
        relying_party_id?: string;
        user_verification?: string;
    };
}

Type declaration

  • Optional email_otp_enabled?: boolean
  • Optional preferred_challenge?: string
  • Optional sms_otp_enabled?: boolean
  • Optional web_authn?: {
        relying_party_id?: string;
        user_verification?: string;
    }
    • Optional relying_party_id?: string
    • Optional user_verification?: string

Optional standard_required_attributes

standard_required_attributes?: string[]

Optional unauthenticated_identities_enabled

unauthenticated_identities_enabled?: boolean

user_pool_client_id

user_pool_client_id: string

user_pool_id

user_pool_id: string

Optional user_verification_types

user_verification_types?: string[]

Optional username_attributes

username_attributes?: string[]

Settings

Member Visibility

Theme

On This Page