Skip to main content
Version: v4

Amazon Cognito

Documentation

https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html

Configuration

https://console.aws.amazon.com/cognito/users/

You need to select your AWS region to go the the Cognito dashboard.

Options

The Amazon Cognito Provider comes with a set of default options:

You can override any of the options to suit your own use case.

Example

import CognitoProvider from "next-auth/providers/cognito";
...
providers: [
CognitoProvider({
clientId: process.env.COGNITO_CLIENT_ID,
clientSecret: process.env.COGNITO_CLIENT_SECRET,
issuer: process.env.COGNITO_ISSUER,
})
]
...
tip

The issuer is a URL, that looks like this: https://cognito-idp.{region}.amazonaws.com/{PoolId}

PoolId is from General Settings in Cognito, not to be confused with the App Client ID.

danger

Make sure you select all the appropriate client settings or the OAuth flow will not work.

tip

Before you can set these settings, you must set up an Amazon Cognito hosted domain. The setting can be found in App Client/Edit Hosted UI.