Managing OIDC Providers

Control Plane allows operators to set up OpenID Connect (OIDC) for authentication. Creating and updating providers can be done via both the user interface and the API.

Configuration file

Since version 1.6.0 Control Plane supports managing OIDC providers from the configuration file in a limited capacity. The user interface or API should be used going forward.

The Authentication.Methods.OIDC block in the configuration file is now only used to seed initial OIDC provider data into the database. During server start-up the configuration file is read and new providers are loaded into the database.

All changes to providers after initial seed must be done via the UI or API.

Database

OIDC provider information is now stored in the database. This means that provider changes are instantly updated on change without requiring a server restart.

User interface

For Control Plane administrators the OIDC providers page is accessible through the /teams page. This can be accessed by clicking on the cog icon in the top right of the Control Plane navigation bar.

Overview

The overview panel shows all available OIDC providers as a list.

Adding a provider

To add a new provider, navigate to the OIDC overview page. Then follow these steps:

1. Click the Add Provider button
2. Fill out the provider details provided from your provider documentation
3. Click the Save button

Updating a provider

To update an existing provider, navigate to the OIDC overview page. Then follow these steps:

1. Click on the provider Name in the left hand column of the providers table
2. The provider detail page should now be loaded into view
3. Click on the pencil icon in the top right of the provider card component
4. A side draw will open, pre-populating existing data. Amend any fields as required
5. Click the Save button to persist the changes

Deleting a provider

To delete a provider, navigate to the OIDC overview page. Then follow these steps:

1. Click on the provider Name in the left hand column of the providers table
2. The provider detail page should now be loaded into view
3. Navigate to the bottom of the page
4. Inside the Danger Zone red box, click on Delete Provider
5. A confirmation alert will appear, clicking Delete will remove the provider permanently