AWS Cognito Directory Integration with Unifed
You can integrate your AWS Cognito directory with Unifed to sync users automatically. This guide explains the setup process.
Before You Begin
- Make sure you are logged in with your Unifed Admin credentials.
Have access to your AWS Account with Cognito User Pool.
Keep the following details ready:
- Access Key ID
- Secret Access Key
- Region
- User Pool ID
Steps to Connect AWS Cognito Directory
Step 1: Configuration
- Log in to your Unifed Admin portal.
- Select the tenant where you want to sync the directory.
- Under Features, click Directory Sync.
Click Add Directory and choose AWS Cognito.
Enter the following details:
- Access Key ID*
- Secret Access Key*
- Region* (example:
us-east-1
) User Pool ID* (example:
us-east-1_XXXXXXX
)(Optional) Enable Auto Deletion for Users.
- If a user is deleted in Cognito, they will also be deleted from Unifed during the next sync.
👉 How to Get These Details from AWS Cognito
- Sign in to the AWS Management Console.
- Go to IAM > Users and create or select a user with programmatic access.
- Attach a policy that allows Cognito User Pool read access (e.g.,
AmazonCognitoReadOnly
). - Download the Access Key ID and Secret Access Key for that user.
- Go to Amazon Cognito > User Pools and copy your User Pool ID.
- Note your AWS Region (e.g.,
us-east-1
,ap-south-1
).
Step 2: User Mapping
- Map Cognito attributes to Unifed schema attributes.
- Only mapped users will be synced into Unifed.
Example:
email
→email
given_name
→firstName
family_name
→lastName
Step 3: Policy
- Define sync conditions (e.g., filter based on attributes or groups).
- This helps in syncing only the required users into Unifed.
Step 4: Scheduler
- Choose how you want to sync users:
One-time sync (manual).
Periodic sync:
- Every hour
- Daily at a specific time
Step 5: Sync & Manage
After setup, users will be synced into Unifed and shown in the User List with Onboarded status.
You can:
- View the Job List.
- Perform a Manual Sync anytime by clicking the Sync button.
- Update the Directory Configuration if needed.