Skip to content

Configuring OAuth2 in X3

  Less than to read

This part of the guide covers implementing OAuth2 authentication in X3. The examples here correspond to the client created in the Creating an OAuth2 Client section.

Creating an OAuth2 Service

  1. Go to Administration > Administration > Settings > Authentication > OAuth2 Servers.
  2. Click New OAuth2 service.
  3. Enter the the following values:
    • Name: Google
    • Display name: Sign in via Google (This value will be displayed on the X3 login screen as a button.)
    • URL for authorization:
    • URL to get access token:
    • OAuth2 client ID and OAuth2 client secret: the values correspond to the the client ID and the client secret obtained at the end of the Creating a Client ID section.
    • Scope for Oauth2 requests:
    • Batch Authentication: check this box
    • URL for requesting user data:
    • User field in user name answer: email
  4. Click Save.

Linking Your Users to an OAuth2 Service

You can now follow these steps to enable OAuth2 authentication for a user:

  1. In X3, go to Administration > Administration > Users > Users.
  2. Select OAuth2 as the Authentication method.
  3. In the OAuth2 instance field, select the google service.
  4. Set Email to the user’s Google email address.
  5. Click Save.

Repeat these steps for any users executing web services.

Logging In with OAuth2

OAuth2 is not just for web services; it can provide another way for users to sign in.

  1. Click the Sign in via Google button on the login screen.
  2. Once redirected to the Google site, authenticate using your Google account, if not already done.
  3. When prompted to, allow X3 to access your Google profile when logging in for the first time.

You can also add a direct link (e.g., to your bookmarks and use it to log in.

Note: You will be authenticated until you log out of your Google account, or until you clear your browser’s cookies. As a result, X3 may not ask you to authenticate each time.

Next Steps