Skip to main content

Interface: AuthOptions

Auth instance options

Properties​

identityPoolId​

identityPoolId: string

Amazon Cognito Identity Pool ID

region?​

optional region: string

signUpVerificationMethod?​

optional signUpVerificationMethod: "code" | "link"

This is used when autoSignIn is enabled for Auth.signUp 'code' is used for Auth.confirmSignUp, 'link' is used for email link verification

userPoolClientId?​

optional userPoolClientId: string

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

userPoolId​

userPoolId: string

Amazon Cognito User Pool ID

userPoolWebClientId?​

optional userPoolWebClientId: string

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

Deprecated​