Skip to content

Add a New OpenAthens Connection

This guide explains how to add a new customer organization to the OpenAthens Keystone connection.

Prerequisites

  • Access to the platform-sso-services repository
  • Understanding of the customer's domain
  • Permissions to modify the domain mapping files

Easy Way

The easiest way is to run a GitHub Actions workflow that takes care of the steps mentioned below.

Running GitHub Actions Workflow to add a new OpenAthens customer

  • Domain value to add corresponds to the "scope" (usually the domain of the customer)
  • User ID value to add corresponds to the internal customer ID

After clicking "Run workflow", the workflow will create a pull request (see here for an example) that will need to get merged.

Manual Steps

Follow the detailed instructions in the Adding a New Customer to the Open Athens Connection documentation.

The process involves:

  1. Identifying the customer's domain from their eduPersonScopedAffiliation attribute
  2. Adding the domain mapping to the appropriate environment file in platform-sso-services/data/
  3. Testing the connection (linting)
  4. Deploying the changes

Environment Files

There are three environment-specific JSON files for domain mappings:

  • Development/Local environment
  • Stage environment
  • Production environment

All files are located at: https://github.com/CPE-Orga/platform-sso-services/tree/main/data

Need Help?

Contact the UAS team if you encounter issues or need assistance with the onboarding process.

Last updated: March 24, 2026 at 10:39
By: Axel Tetzlaff