Files
personal_site/frontend/node_modules/@aws-amplify/auth-construct/lib/defaults.d.ts
T

68 lines
1.9 KiB
TypeScript

import { AuthProps } from './types.js';
/**
* These are the Amplify provided default values for Auth.
*/
export declare const DEFAULTS: {
/**
* Default Auth Props if customer does not provide any.
*/
IF_NO_PROPS_PROVIDED: AuthProps;
/**
* Sign in case sensitivity
*/
SIGN_IN_CASE_SENSITIVE: boolean;
/**
* Specifies if users can sign up on their own.
* If set to false, users will not be able to register, and will require an admin to create
* their account.
*/
ALLOW_SELF_SIGN_UP: boolean;
/**
* Specifies whether the identity pool should support unauthenticated identities
*/
ALLOW_UNAUTHENTICATED_IDENTITIES: boolean;
/**
* Specifies whether user existence errors should be shown.
* Enabling this protects users as it does not allow attackers to know if users
* are created in the backend.
*/
PREVENT_USER_EXISTENCE_ERRORS: boolean;
/**
* Default password policy
*/
PASSWORD_POLICY: {
minLength: number;
requireLowercase: boolean;
requireUppercase: boolean;
requireDigits: boolean;
requireSymbols: boolean;
};
/**
* Specifies if SRP or custom logins should be enabled.
*/
AUTH_FLOWS: {
userSrp: boolean;
custom: boolean;
};
/**
* Default OAUTH flows for the UserPool
*/
OAUTH_FLOWS: {
authorizationCodeGrant: boolean;
implicitCodeGrant: boolean;
};
/**
* Specifies if attributes are required for signup/login, may depend on which settings are enabled.
*/
IS_REQUIRED_ATTRIBUTE: {
email: (emailEnabled: boolean) => {
required: boolean;
mutable: boolean;
} | undefined;
phoneNumber: (phoneNumberEnabled: boolean) => {
required: boolean;
mutable: boolean;
} | undefined;
};
};
//# sourceMappingURL=defaults.d.ts.map