Connecting using OpenId Connect

If your authentication provider is compatible with OpenID connect, you can allow your users to authenticate to WorkAdventure using their credentials from your authentication provider. By connecting to an external OpenID provider, WorkAdventure allows users to use their existing login information from that provider to access the WorkAdventure service, making it easier and more convenient for them to log in. This also provides an additional layer of security, as the authentication is handled by your provider, rather than WorkAdventure itself. Bo OpenId connect form

Choosing the world to link your SSO OpenId connect with

To configure your provider, you will have to fill these 5 input fields:

  • Application name: name of your SSO settings for WorkAdventure, it does not affect the OpenId connection protocol.
  • Application id: ID of your SSO OpenId provider. This information is provided by your provider.
  • Application secret: Secret of your SSO OpenId provider. This information is provided by your provider.
  • OpenId SSO Domain: URL of your provider. Your OpenId SSO provider should have well-know configuration setting defined URL: /.well-known/openid-configuration. For example for the Google OpenId provider, the well-know configuration URL is https://accounts.google.com/.well-known/openid-configuration. So the OpenId domain is https://accounts.google.com
  • Scope: Scope available for your OpenId provider (openid, profile, email...). You should at least put the "openid" scope.

Authentication mandatory

If you switch on this parameter, any visitor coming to your world will be redirected to the login page of your authentication provider.

SSO settings information

  • Our domain is: https://workadventu.re.
  • The redirect URI of your SSO settings will be https://workadventu.re/oauth/<application_id>/callback
  • Our privacy policy: https://workadventu.re/privacy-policy
  • Our term of use: https://workadventu.re/terms-of-use
  • Our cookie policy: http://workadventure.localhost/cookie-policy
  • Our Sub-processors: http://workadventure.localhost/subprocessors

Example: Connecting to Google OpenId provider

Create your API Key

Go to Google Cloud Platform : https://console.cloud.google.com/apis/credentials Create an ID client Oauth.

Google OpenId connect form

In the settings form, the WorkAdventure information are:

  • Javascript authorize: https://workadventu.re
  • Redirect url authorize: https://workadventu.re

Google authorize

After this step, your Id and Secret will be generated.

The key generated is listed on your "Client ID Oauth2.0" dashboard.

Google id and secret

Consent Google Oauth

The second and last step is on the Oauth consent screen.

If not already specified, set "User Type" to allow access for all selected individuals. After that you can update or create consent page.

Google consent settings

Required fields:

  • Home page: https://workadventu.re
  • Privacy policy: https://workadventu.re/privacy-policy
  • Terms of use: https://workadventu.re/terms-of-use
  • Domain: workadventu.re

There are more details about you.

Google consent settings form

After that, you need to set the scope of your Google SSO provider, as well as set the level of access to the information we can request from your provider for the connected user.

As of this writing, WorkAdventure uses only the email address and the name of the user (you can force the user to use his/her name of OpenID in the world settings).

Google consent settings form

If all information has been validated, the next step should be confirmation.

If you have any questions, feel free to contact us.

< Preparing your network