Generic OAuth Provider
Last updated
Last updated
Since OpenFlower v2.4.0, a generic OAuth Provider has been introduced. The goal is to cover as many OAuth providers as possible without special implementation but give you, as an Admin, the freedom to connect to any OAuth Provider using a flexible configuration.
OAuth Providers are configured individually per Workspace.
The configuration has three parts:
Meta-Data
OAuth Provider Configuration
Information Mapping
As the Admin of your Workspace, go to Settings > User Authentication. Here, you will find a List of your configured User Authentication Providers.
Now, you can use the button in the upper right corner to add a new OAuth Provider. Select "Generic".
The .well-known/openid-configuration URI is specifically part of the OpenID Connect (OIDC) standard. If a provider supports OpenID Connect, this endpoint provides a JSON document with the configuration details for OAuth and OIDC operations. OpenFlower will try to use this configuration data and will fill out the standard OAuth Provider Configuration fields as well as possible in the next screens of the Generic OAuth Provider Configurator.
Here are some popular services and their OpenID configuration Endpoints
Meta Data describes the Auth Source, allowing you to influence the visual representation of the OAuth Provider in the Sign In / Sign Up screen.
In OpenFlower v2.4.0 you must set the field "Source" to GENERIC
From OpenFlower v2.4.1, the field "Source" will be hidden and filled out automatically.
In Step 2, you can now set up the configuration Data for your OAuth Provider. We introduced this in v2.4.0, and the screen will surely be extended with features in the upcoming versions.
Scopes must be set with a space character between the scopes, not comma-separated.
At your IDM you would need to prepare an OAuth Client resp. a OAuth Client Application. There are multiple settings.
Redirect URL. Here you enter your domain of your installation like http://localhost:3000 or https://prod-us1.openflower.org
Scopes: You should set the following Scopes if possible. offline_access and profile are important.
openid
offline_access
profile
Supported OAuth2 flows: To handle User-Logins you need to activate the Authorization Code Flow. Also you may need to activate the Refresh Token possibility.
Client authentication mechanism: Here, you can set HTTP Body
We introduce the possibility of mapping Data from OAuth providers to OpenFlower. We just started it in v2.4.0, and in this version, we enabled 4 attributes.
UID (The User-ID in the IDM System)
Email (The Email Address of the User in the IDM System)
Username (The Name of the User)
Avatar (The profile picture of the User)
The second screen shows how the Avatar and Username come into effect after the Mapping.
In v2.4.0 we support mapping out of the JWT (access_token) from the IDM. In future versions, we will also support the mapping of Attributes from the OpenID /userInfo endpoint.
