Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Cognito User Sync job will synchronize users in Clarity to AWS Cognito. Cognito is only for Authentication, while Clarity will maintain all Authorization (Security Groups, Access Rights, etc.). Administrators can create the users in Clarity and when the Cognito User Sync job runs, it will create/update the user in Cognito. This is intended to be a scheduled job (recommended daily). Below are instructions and recommendation on scheduling the job in your environment.

Scheduling the Job:

  1. Navigate to Home->Reports and Jobs

  2. Click the Cognito User Sync job

  3. Fill in the Sync Date parameter based on your Organization’s need. See below for details on both versions you can run and recommendations you can follow:

    1. Full Sync: To perform a Full sync, you will leave the Sync Date blank. This will cause all of the accounts to be written to the Cognito Service. This is recommended if you have an integration that will update each resource record when it runs.

    2. Incremental Sync: This will run as long as you have set a Sync Date. This version of the job will read each resource that has been updated since the sync date. It compares the date selected in the parameter to Resource’s last updated date. This is recommended if you manually create or update users or have a resource integration that does not update each resource when running. If you have an integration that updates each resource and set a Sync Date, this job will take longer than the Full Sync.

  4. Set the Scheduled section to your Organization’s needs.

  5. Set the Notification section to your Organization’s needs.

  6. Click Submit