Skip to main content

Interface: AuthOptions

Configuration options for the authentication service. These options are required to initialize the authentication module with AWS Cognito.

Example​

const authOptions: AuthOptions = {
  userPoolId: 'us-east-1_xxxxxxxx',
  userPoolClientId: 'xxxxxxxxxxxxxxxxxxxxxxxxxx',
  identityPoolId: 'us-east-1:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  region: 'us-east-1'
};

window.mimeeqAuth.initialize(authOptions, null, null);

Properties​

identityPoolId​

identityPoolId: string

Amazon Cognito Identity Pool ID. This is used for obtaining temporary AWS credentials for accessing other AWS services.

region?​

optional region?: string

AWS region where the Cognito services are hosted. For example: 'us-east-1', 'eu-west-1', etc.

signUpVerificationMethod?​

optional signUpVerificationMethod?: "link" | "code"

The verification method to use during sign-up.

  • 'code': Uses verification codes sent to email/phone
  • 'link': Uses verification links sent to email

userPoolClientId?​

optional userPoolClientId?: string

Amazon Cognito Web Client ID (App client secret needs to be disabled). This identifies the specific application that is authorized to access the User Pool.

userPoolId​

userPoolId: string

Amazon Cognito User Pool ID. This identifies the user directory where user accounts are stored.

userPoolWebClientId?​

optional userPoolWebClientId?: string

Amazon Cognito Web Client ID (App client secret needs to be disabled)

Deprecated​