This repository contains scripts and configuration for the Companies House ForgeRock Identity Cloud tenant. All scripts are used as part of the CI/CD pipeline but can also be ran locally.
Not all steps can be run against Staging and Production tenants; all changes to static configuration must be applied via the configuration promotion process. Changes to dynamic configuration can be aplied to all types of tenants. For more information refer to the Identity Cloud docs: https://backstage.forgerock.com/docs/idcloud/latest/tenants/promote-configuration.html
The following need to be installed/configured for local use:
A .env file can be used for setting environment variables when running locally. Copy the .env.sample file to a new file called .env and update the values for the environment.
| Name | Description | Default Value | Required |
|---|---|---|---|
| FIDC_URL | ForgeRock Identity Cloud URL | N/A | ✅ |
| FIDC_COOKIE_NAME | ForgeRock Identity Cloud cookie name | N/A | ✅ |
| SERVICE_ACCOUNT_ID | ForgeRock Service Account ID | N/A | ✅ |
| SERVICE_ACCOUNT_KEY | ForgeRock Service Account JSON key | N/A | If SERVICE_ACCOUNT_KEY_PART_1 and SERVICE_ACCOUNT_KEY_PART_2 are not set |
| SERVICE_ACCOUNT_KEY_PART_1 | First half of the ForgeRock Service Account JSON key | N/A | If SERVICE_ACCOUNT_KEY is not set |
| SERVICE_ACCOUNT_KEY_PART_2 | Second half of the ForgeRock Service Account JSON key | N/A | If SERVICE_ACCOUNT_KEY is not set |
| UI_URL | CH Account UI URL | N/A | ✅ |
| OAUTH2_HASH_SALT | Hash salt to be use by OAuth2 service | N/A | ✅ |
npm install
npm link
npm test
All scripts can also be ran locally using the CLI with the correct arguments and environment variables.
The available CLI commands can be found using the help option: update-fidc -h
Each command also has it's own help option, for example: update-fidc applications -h