Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 5.51 KB

README.md

File metadata and controls

109 lines (73 loc) · 5.51 KB
Raw

IdP ID Sync

Tool to synchronize user records between the ID Broker and an ID Store

Configuration

By default, configuration is read from environment variables documented in the local.env.dist file. Copy this file to local.env and supply any necessary values.

Optionally, you can define configuration in AWS AppConfig. To do this, set the following environment variables to point to the configuration in AWS:

  • AWS_REGION - the AWS region in use
  • APP_ID - the application ID or name
  • CONFIG_ID - the configuration profile ID or name
  • ENV_ID - the environment ID or name

In addition, the AWS API requires authentication. It is best to use an access role such as an ECS Task Role. If that is not an option, you can specify an access token using the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY variables.

The content of the configuration profile takes the form of a typical .env file, using # for comments and = for variable assignment. Any variables read from AppConfig will overwrite variables set in the execution environment.

Testing

Run all except integration tests

Run make testci

Run a single test suite

Note: Before running an individual test, you might need to bring up various other containers needed (like "broker"), depending on which test you will run. An easy way to do that is to simply run make testci first, then use one of the following to run just a specific test.

  • make bash
  • vendor/bin/behat --config=features/behat.yml --suite=notification_features

OR

  • docker compose run --rm cli bash -c "vendor/bin/behat --config=features/behat.yml --suite=notification_features"

Substitute notification_features with any of the suites defined in behat.yml

Integration tests

Some additional setup is required to run integration tests:

Google config

  • Create a Google Sheets using the google-sheets.csv template file
  • Copy sheet ID from the browser address bar. It's the long string of characters after /d/ and before /edit
  • Save sheet ID in local.env as TEST_GOOGLE_SHEETS_CONFIG_spreadsheetId
  • Set TEST_GOOGLE_SHEETS_EMPLOYEE_ID in local.env to 1234567
  • Set TEST_GOOGLE_SHEETS_CONFIG_applicationName in local.env to id-sync
  • Create Google auth token (TBD: include or link to instructions)
  • Save token in application/google-auth.json and set TEST_GOOGLE_SHEETS_CONFIG_jsonAuthFilePath to /data/google-auth.json

Workday config

Unless you have access to a test-only Workday account, you will need a valid employee ID and valid Workday credentials. Set the TEST_WORKDAY_CONFIG_***** variables in local.env using local.env.dist as an example.

Sage People config

Unless you have access to a test-only Sage account, you will need a valid employee ID and valid Sage credentials. Set the TEST_SAGE_PEOPLE_CONFIG_***** variables in local.env using local.env.dist as an example.

User properties

Employee Number (employee_number)

This is the primary key that uniquely identifies each user record. It can consist of any alph-numeric characters. Required.

First Name (first_name)

A user’s first name. Required.

Last Name (last_name)

A user’s last name.

Display Name (display_name)

A user’s full name. If blank, the display name will be the first name and last name concatenated with a space in between.

Email (email)

A user’s primary email address. The user must have a primary email address. The ALLOW_EMPTY_EMAIL configuration option can be set to true to temporarily allow a user to only have a personal email address (see below). This can be useful if the onboarding process does not allow for an organizational email address to be created before the IdP user is added.

Username (username)

A user’s username. The user can use either their username or their email address on login. Required.

Account Locked, Disabled or Expired (locked)

Flag to identify a temporarily disabled account. Must be one of: ‘yes’, ‘true’, 1, ‘no’, ‘false’, 0. Note that this is in addition to the “active” property that is implicitly set (or cleared) by the user’s inclusion in (or later exclusion from) the list of users provided to the IdP.

Require MFA (requireMfa)

Flag to enforce the use of multi-factor authentication. Must be one of: ‘yes’, ‘true’, 1, ‘no’, ‘false’, 0

Manager Email (manager_email)

Email address of the user’s manager. This can be used in a situation where a user loses access to their multi-factor authentication and needs assistance. In such a situation, they can request assistance from their manager, who will receive a temporary code that can be given to the user once they have positively identified the person.

Personal Email (personal_email)

Alternate email address of the user. Upon creation of a new user, if specified, this address will be added as a password recovery option. May also be used temporarily as a new user's primary email address if configuration option ALLOW_EMPTY_EMAIL is true.

Groups (groups)

A comma-separated list of groups that can be used to limit access to certain applications (SAML Service Providers) based on SAML configuration elsewhere in the IdP system.

HR Contact Name (hr_contact_name)

Name of Human Resources contact person, used for notifications such as "New User" notification.

HR Contact Email (hr_contact_email)

Email address of Human Resources contact person, used for notifications such as "New User" notification.