How to Create Pricefx Client OAuth Connection

Aim of this article

Explains how to create an IntegrationManager connection that authenticates to a Pricefx partition with OAuth credentials instead of a user name and password.

Related sections

Connections (Reference Manual)

Pricefx Client OAuth Connection (IntegrationManager documentation)

Required permissions

Integration Instance - Edit

Prerequisites

  • The IntegrationManager instance runs version 8.1.0 or later. On older versions the Pricefx Client OAuth type is not in the Connection type list.

  • The partition runs a release that supports OAuth authorization.

  • An OAuth client is registered on the partition, as the oauthConfiguration entry in Advanced Configuration Options on the partition (Administration > Configuration > Advanced Configuration Options). Its redirect URI is the PlatformManager callback address, {your PlatformManager host}/oauth-callback/index.html. The partition matches the redirect URI as an exact string.

For the partition-side configuration, see OAuth Authorization in the Configuration Knowledge Base.

Steps

  1. Go to Account > Integrations > {integration instance} > Connections and open the Workspace tab.

  2. Add a connection and fill in the fields:

    • Name – Connection name of your choice. A connection named pricefx becomes the instance’s default partition connection.

    • Connection type – Select Pricefx Client OAuth.

    • URI – Address of the partition.

    • Partition – The partition to connect to.

    • Client ID – The Client ID registered on the partition.

    • Certificate – Optional. The same certificate field as for the PriceFx Client connection type.

  3. Click Authorize, to the right of Client Secret. The button stays disabled until URI, Partition and Client ID are filled in. Before you authorize, the badge beside Client Secret reads Not authorized.

  4. Log in to the partition in the popup window and grant access. PlatformManager writes the refresh token it receives into Client Secret, and the badge changes to Authorized.

  5. Click Test connection to confirm that the partition accepts the credentials.

  6. Click Save to keep the connection in the Workspace, or Deploy to deploy it to the instance. Until you do, PlatformManager shows the warning The refresh token was filled in. Save or deploy the connection to store it.

IntegrationManager exchanges the stored refresh token for a short-lived access token and refreshes it automatically. For the IntegrationManager side, see Pricefx Client OAuth Connection.