ℹ️ OpenFin Workspace: OpenFin Workspace is a commercial product and this repo is for evaluation purposes (See LICENSE.MD). Use of the OpenFin Container and OpenFin Workspace components is only granted pursuant to a license from OpenFin (see manifest). Please contact us if you would like to request a developer evaluation key or to discuss a production license.
Your OpenFin application will often need to authenticate with the and SSO provider before use, this examples demonstrates using the OpenId Connect protocol for such an integration.
This application you are about to install is a simple example of plugging in your own content or app. This example assumes you have already set up your development environment
To run this sample you can:
- Clone this repo and follow the instructions below. This will let you customize the sample to learn more about our APIs.
- Install dependencies and build the sample. Note that these examples assume you are in the sub-directory for the example.
npm run setup-
Configure the OpenId Connect provider
The OpenId Connect provider can connect to any provider that supports the standard, such as Okta, Auth0, Azure AD, Google etc
-
Optional (if you wish to pin the version of OpenFin Workspace to version 20.0.0 and you are on Windows) - Set Windows registry key for Desktop Owner Settings. This example runs a utility dos.mjs that adds the Windows registry key for you, pointing to a local desktop owner settings file so you can test these settings. If you already have a desktop owner settings file, this script prompts to overwrite the location. Be sure to capture the existing location so you can update the key when you are done using this example.
(WARNING: This script kills all open OpenFin processes. This is not something you should do in production to close apps as force killing processes could kill an application while it's trying to save state/perform an action).
npm run dos- Start the test server in a new window.
npm run start- Start the demonstration application.
npm run client- Build the project if you have modified the code.
npm run build
Okta can be used as a SSO provider using OpenId Connect.
In order to integrate an SPA with Okta please refer to this link: SPA Redirect
After creating the Okta integration using the example above, populate the customSettings in the public/manifest.fin.json and public/second.manifest.fin.json files in the repo. The providerUrl and clientId values can be viewed in the settings for the application on the Okta Admin management console.
The loginRedirectUrl and logoutRedirectUrl need to be configured in the Okta dashboard settings as valid urls for authentication.
"customSettings": {
"auth": {
"providerUrl": "<PROVIDERURL>",
"clientId": "<CLIENTID>",
"loginRedirectUrl": "http://localhost:8080/oidc_login.html",
"logoutRedirectUrl": "http://localhost:8080/oidc_logout.html"
}
}Auth0 can be used as a SSO provider using OpenId Connect.
After creating the Auth0 integration, populate the customSettings in the public/manifest.fin.json and public/second.manifest.fin.json files in the repo. The providerUrl and clientId values can be viewed in the settings for the application on the Auth0 Admin management console.
The loginRedirectUrl and logoutRedirectUrl need to be configured in the Auth0 dashboard settings as valid urls for authentication.
"customSettings": {
"auth": {
"providerUrl": "<PROVIDERURL>",
"clientId": "<CLIENTID>",
"loginRedirectUrl": "http://localhost:8080/oidc_login.html",
"logoutRedirectUrl": "http://localhost:8080/oidc_logout.html"
}
}