@aws-amplify/amplify-category-auth/API.md

amplify-cli authentication plugin

## API Report File for "@aws-amplify/amplify-category-auth"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { $TSAny } from '@aws-amplify/amplify-cli-core';
import { $TSContext } from '@aws-amplify/amplify-cli-core';
import { AmplifyCategoryTransform } from '@aws-amplify/amplify-cli-core';
import { Template } from '@aws-amplify/amplify-cli-core';

// @public (undocumented)
export function add(context: any, skipNextSteps?: boolean): Promise<any>;

// @public (undocumented)
export class AmplifyAuthTransform extends AmplifyCategoryTransform {
    constructor(resourceName: string);
    // (undocumented)
    applyOverride: () => Promise<void>;
    // (undocumented)
    saveBuildFiles: (context: $TSContext, template: Template) => Promise<void>;
    // (undocumented)
    transform(context: $TSContext): Promise<Template>;
    // (undocumented)
    validateCfnParameters(context: $TSContext, oldParameters: $TSAny, parametersJson: $TSAny): boolean;
}

// @public (undocumented)
export class AmplifyUserPoolGroupTransform extends AmplifyCategoryTransform {
    constructor(resourceName: string);
    // (undocumented)
    applyOverride: () => Promise<void>;
    // (undocumented)
    saveBuildFiles: (__context: $TSContext, template: Template) => Promise<void>;
    // (undocumented)
    synthesizeTemplates: () => Promise<Template>;
    // (undocumented)
    transform(context: $TSContext): Promise<Template>;
}

// @public (undocumented)
export type AuthParameters = {
    dependsOn?: $TSAny[];
    triggers?: string;
    identityPoolName?: string;
    aliasAttributes?: string[];
    usernameAttributes?: string[];
    authProviders?: string[];
    authProvidersUserPool?: string[];
    requiredAttributes?: string[];
    passwordPolicyMinLength?: number;
    passwordPolicyCharacters?: string[];
    mfaConfiguration?: string;
    mfaTypes?: string[];
    autoVerifiedAttributes?: string[];
};

// @public (undocumented)
export function authPluginAPIPush(context: Object): Promise<void>;

// @public (undocumented)
export const category: "auth";

// @public (undocumented)
export function checkRequirements(requirements: any, context: any, category: any, targetResourceName: any): Promise<{
    errors: string[];
    authEnabled?: undefined;
} | {
    authEnabled: boolean;
    errors?: undefined;
}>;

// @public (undocumented)
function console_2(context: any): Promise<any>;
export { console_2 as console }

// @public (undocumented)
export function executeAmplifyCommand(context: any): Promise<void>;

// @public (undocumented)
export function executeAmplifyHeadlessCommand(context: any, headlessPayload: string): Promise<void>;

// @public (undocumented)
export function externalAuthEnable(context: any, externalCategory: any, resourceName: any, requirements: any): Promise<any>;

// @public (undocumented)
export const generateAuthStackTemplate: (context: $TSContext, resourceName: string) => Promise<Template>;

// Warning: (ae-forgotten-export) The symbol "AuthTriggerCfnTypes" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const getAuthTriggerStackCfnParameters: (context: $TSContext, authResourceName: string) => Promise<AuthTriggerCfnTypes>;

// Warning: (ae-forgotten-export) The symbol "FrontEndConfig" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const getFrontendConfig: (authParameters: AuthParameters) => FrontEndConfig;

// @public (undocumented)
export function getPermissionPolicies(context: any, resourceOpsMapping: any): Promise<{
    permissionPolicies: any[];
    resourceAttributes: any[];
}>;

// @public (undocumented)
export function handleAmplifyEvent(context: any, args: any): Promise<void>;

// @public (undocumented)
export function importAuth(context: any): Promise<any>;

// @public (undocumented)
export function initEnv(context: any): Promise<void>;

// @public (undocumented)
export function isSMSWorkflowEnabled(context: any, resourceName: any): Promise<boolean>;

// @public (undocumented)
export const migrate: (context: $TSContext) => Promise<void>;

// @public (undocumented)
export function migrateAuthResource(context: any, resourceName: any): Promise<boolean>;

// @public (undocumented)
export function prePushAuthHook(context: any): Promise<void>;

// @public (undocumented)
export function transformCategoryStack(context: any, resource: any): Promise<void>;

// @public (undocumented)
export const updateAppClientWithGeneratedSecret: (context: $TSContext) => Promise<void>;

// @public (undocumented)
export const uploadFiles: (context: $TSContext) => Promise<void>;

// (No @packageDocumentation comment for this package)

```