Register a Client Application

Register a client application so you can authorize access to your Visier account using OAuth 2.0.

Who can use this feature?

Users with this profile additional capability: 

  • OAuth 2.0 Client Registration

Not sure if you have this feature or capability? Reach out to your administrator.

Overview

OAuth 2.0 is an authorization standard that, when set up in Visier, allows you to access your Visier credentials in other applications; for example, Visier® Smart Compensation. For more information, see OAuth 2.0. Each user who wants to authorize their Visier credentials in other applications must create an OAuth client in Visier for that application. This article describes how users can register OAuth 2.0 clients in Visier to enable three-legged authorization.

OAuth 2.0 relies on a combination of a client ID and redirect URIs to securely authorize Visier user credentials in other applications, as described next.

  • Client ID: A Visier-generated unique identifier for the registered OAuth 2.0 client.
  • Redirect URIs: A list of URLs through which to send single-use authorization codes from Visier's server back to the other application. Redirect URIs are typically a URL associated with the client application.
  • Client secret: A Visier-generated secret to protect the registered OAuth 2.0 client. This is only shown once.

Create a client registration

To set up OAuth 2.0 for your Visier tenant, you must first create a client registration in the studio experience. This registers your OAuth 2.0 client with Visier's authorization server. Client registration is required before you can use OAuth 2.0 to get your Visier data in other applications. The OAuth 2.0 client allows other applications to obtain a token representing your Visier user that authorizes the other application to take action on your behalf, such as querying Visier's platform.

Each Visier tenant may contain a maximum of 100 client registrations.

  1. On the global navigation bar, click Settings > OAuth 2.0.
  2. Click Create Client Registration.
  3. In Client name, type a display name for the client registration.
  4. In Redirect URIs, type the URLs through which Visier can send authorization codes to the client application. Redirect URIs are typically a URL associated with the client application.

    Note: Each client registration may contain a maximum of 50 redirect URIs.

  5. When finished, click Create.

    Result: Visier assigns a client ID and client secret to the client registration, as shown in the following screenshot.

  6. Beside the Client ID, click the Copy button . You need the client ID to authorize your Visier credentials in other applications.
  7. Beside Client secret, click the Copy button . You need the client secret to authorize your Visier credentials in other applications.

    Warning: Store the client secret in a secure location. The client secret is not accessible after you close the Registration success dialog.

  8. When finished, click Done.

    Result: You can now access your Visier credentials in other applications.