OAuth for Maximizer On-Premise

On-premise installations of Maximizer host their own OAuth endpoints. The Authorization Code Flow is the same as for Maximizer Cloud; only the setup and the endpoint URLs described below differ.

Setting Up an OAuth Client in Administrator

Unlike Maximizer Cloud, where credentials are issued by the Maximizer team, on-premise OAuth clients are created in Maximizer Administrator:

1. Access Maximizer Administrator:
   • Log in with an account that has the Administrator role.
2. Navigate to OAuth Settings:
   • In the left pane, under Preferences, select System Options.
   • Click on the OAuth 2.0 Settings tab.
3. Add a New OAuth Client:
   • Click Add.
   • Enter the following details:
     • Name: The name of your OAuth 2.0 client application.
     • Redirect URI: The authorized URIs where users will be redirected after authorization. Supports multiple URIs separated by comma. During authorization, a single URI must be provided and it should match one of the URIs registered in this field.
4. Save the Client Profile:
   • Click Save to generate the client_id and client_secret.

Note: If you're developing for third-party clients or customers, provide them with instructions to configure the OAuth Client Profile for their applications.

Endpoint URLs

Maximizer OAuth is installed alongside Maximizer.Web.Access in an IIS application named "MaximizerWebAuthentication." The default endpoint URLs are:

• {server}: Domain name of your Web Access server.

Differences from Maximizer Cloud

When following the Authorization Code Flow against an on-premise installation, keep in mind:

• Use the endpoint URLs above instead of the auth.maximizer.com URLs.
• In Step 2, the user signs in through the Maximizer login page directly, rather than the e-mail-first sign-in experience.
• Refresh tokens are short opaque strings rather than JWTs. Treat them as opaque strings either way.