How to Add a Whitelisted Service Client

This guide explains how to create and configure a whitelisted service client.

Steps

1. Create Service Client Key in Authress

1. Navigate to the Authress Management Portal
2. Create a new service client
3. Make note of your chosen name as it will be needed for the whitelist configuration. The name should be lowercase and use hyphens instead of spaces.
4. Securely store the generated service client key

2. Add Client to Whitelist Configuration

1. Locate the WhitelistedServiceClients enum inside dependencies.py.
2. Add a new entry for your service client following these rules:
3. Use lowercase letters
4. Replace spaces with hyphens
5. Example: If your service client name is "My Service", the enum entry should be "my-service"
6. Commit the changes and push to the repository.