OpenID Connect configuration¶
Objects API supports Single Sign On (SSO) using the OpenID Connect protocol (OIDC) for the admin interface.
Users can login to the Objects API admin interface, using their account registered by the OpenID Connect provider. In this flow:
The user clicks on Login with organization account in the login screen.
The user is redirected to the website of the OpenID Connect provider (i.e., Keycloak), where they log in with username and password (and possible Multi Factor Authentication).
The OIDC website sends the user back to Objects API (where the account for the user is created, if it does not yet exist).
An admin in Objects API assigns the account to the appropriate groups when the user logs in to their account for the first time.
By default, the account is created, but it does not get access to the admin interface. These permissions must be configured by (another) admin.
Configuration of OIDC provider¶
Contact the IAM admins in your organization to create a Client in the environment of the OpenID Connect provider
As Redirect URI enter
open-notificaties.municipality.nl is substituted with the relevant domain.
At the end of this process, the following data must be returned (on premise):
Server addres, i.e.,
Client ID, i.e.,
Client secret, i.e.,
Configuration of OIDC in Objects API¶
Ensure you possess the following data:
Then, in the admin interface navigate to Configuration > OpenID Connect configuration.
Check Enable to enable OIDC.
For OpenID Connect client ID enter the Client ID, i.e.,
For OpenID Connect secret enter the Client secret, i.e.,
Leave the default value for OpenID Connect scopes.
For OpenID sign algorithm enter
Leave Sign key blank.
Thereafter, a few endpoints belonging to the OIDC provider must be configured.
These can be derived automatically from the discovery endpoint
For Discovery endpoint enter the path to the correct authentication realm endpoint of the OpenID Connect provider (ending in a /), i.e.,
Leave the remaining endpoints blank.
Finally, click the Save button in the bottom right corner.
The simplest way to test if OIDC authentication functions properly, is by navigating to https://objects.municipality.nl/admin/ in an incognito window and clicking Login with organization account.