Integration Users REST APIs

Overview

Oracle CPQ 26B introduces the Integration Users REST API endpoints to support integration users for Oracle CPQ running in Oracle Fusion. This REST API can be downloaded from the Admin Home > Integration > Integration Catalog from the CPQ site running in Fusion.

The Integration Users endpoints retrieve, create, and update integration users for Oracle CPQ running in Fusion.

Administration

All new Oracle CPQ sites running in Oracle Fusion require the following Uniform Resources Locator (URL) path for all CPQ pages, endpoints, and file paths. The new standard URL path will include /cpq/. Refer to the following example:

New URL Format: /cpq/rest/v19/parts
Old URL Format: /rest/v19/parts

The URL path change does not impact existing sites not running in Oracle Fusion. However, we recommend all administrators apply this new format to all new URLs and suggest you consider transitioning from your existing URL path to the new URL path.

Get All Integration Users

Get All Integration Users
Description	This endpoint returns a list of integration users across all companies.
URI Endpoint	/cpq/rest/v19/integrationUsers
Endpoint Query Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. q - Declares a query specification expression. expand - return child resource details. Supports only groups. limit -Specifies the number of records to be fetched. offset - Specifies the offset in the record set to start the response from. Usually used in conjunction with limit parameter to obtain the next set of records. totalResults - Specifies that the total count of records should be included in the response when doing pagination. Only effective when limit or offset are specified. orderby - Specifies a comma-separated list of fields to order the response by. excludeLinks - Exclude links from the response. Allowed values: `self`, `child`, `parent`, `canonical`, `next`, `prev`, and `related`. fields - A list of fields to be returned.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	The response contains a collection of integration users

URI Endpoint Sample

Sample Response Body

{ "items": [{ "login": "_custom_user_6ab1180a3cce465983d1c000144b6f1b", "isNotifyFax": false, "isNotifyEmail": true, "isUserAdminPermEnabled": false, "isApplicationAdminPermEnabled": false, "isWebServicesOnly": true, "isAccessAdminPermEnabled": false, "isProxyPermEnabled": false, "partyId": 181556695830934950, "partyNumber": "BM_Zb69fNkzcp8", "dateModified": "2025-09-26T12:17:59.000Z", "dateAdded": "2025-09-26T12:17:59.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_Zb69fNkzcp8" }, { "rel": "child", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_Zb69fNkzcp8/groups" } ], "lastLogin": "2025-09-26T12:18:55.000Z", "type": { "value": "FULL_ACCESS", "displayValue": "FullAccess" }, "language": { "value": "en_US", "displayValue": "English" }, "currency": { "value": "USD", "displayValue": "US Dollar" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "units": { "value": 1, "displayValue": "English" }, "dateFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "status": { "value": 1, "displayValue": "Active" }, "oauthClientId": "6ab1180a3cce465983d1c000144b6f1b", "company": { "name": "cpq-mdb", "loginName": "_host" } } ], "offset": 0, "limit": 1000, "count": 34, "hasMore": false, "links": [{ "rel": "canonical", "href": "http://sitename.oracle.com/cpq/rest/v19/users" }, { "rel": "self", "href": "http://sitename.oracle.com/cpq/rest/v19/users?offset=0&limit=1000" } ] }

Get an Integration User

Get an Integration User
Description	This endpoint returns details about a specific integration user.
URI Endpoint	/cpq/rest/v19/integrationUsers/{partyNumber}
Endpoint Parameters	partyNumber	The unique identifier for the user
Endpoint Parameters	This endpoint supports the following query specifications. For more information, see Manage Collections. expand - return child resource details. excludeLinks - Exclude links from the response. fields - A list of fields to be returned.
HTTP Method	GET
Request Body Parameters	None
Response Body Parameters	JSON data for the specific integration user Note: HTTP Code 404 displays if integration user does not exist.

URI Endpoint Sample

Sample Response Body

{ "login": "_custom_d4279b7d50a843ffb14c709dab1f1418", "isNotifyFax": false, "isNotifyEmail": true, "isSuperUserPermEnabled": false, "isApplicationAdminPermEnabled": false, "isWebServicesOnly": true, "isAccessAdminPermEnabled": false, "isProxyPermEnabled": false, "partyId": 318766884429645907, "partyNumber": "BM_LaeNrP1bCh5", "dateModified": "2025-10-14T08:29:21.000Z", "dateAdded": "2025-10-14T08:29:21.000Z", "links": [{ "rel": "self", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_LaeNrP1bCh5?expand=groups" }, { "rel": "child", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_LaeNrP1bCh5/groups" }, { "rel": "canonical", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_LaeNrP1bCh5" } ], "type": { "value": "FULL_ACCESS", "displayValue": "FullAccess" }, "language": { "value": "en_US", "displayValue": "English" }, "currency": { "value": "USD", "displayValue": "US Dollar" }, "numberFormat": { "value": 0, "displayValue": "####.##" }, "timeZone": { "value": "America/Chicago", "displayValue": "(GMT-6:00 GMT-5:00) Chicago" }, "units": { "value": 1, "displayValue": "English" }, "dateFormat": { "value": 0, "displayValue": "MM/dd/yyyy h:mm a" }, "status": { "value": 1, "displayValue": "Active" }, "groups": { "items": [{ "label": "Admin Access- Groups", "variableName": "adminAccessGroupsOnly", "type": "Administrator" }, { "label": "No Longer Used 07", "variableName": "excludeMDBParts", "type": "Sales" } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_LaeNrP1bCh5/groups" }, { "rel": "parent", "href": "http://sitename.oracle.com/cpq/rest/v19/users/BM_LaeNrP1bCh5" } ] }, "oauthClientId": "d4279b7d50a843ffb14c709dab1f1418", "company": { "name": "cpq-mdb", "loginName": "cpq-mdb" } }

Create an Integration User

Create an Integration User
Description	This endpoint creates an integration user.
URI Endpoint	/cpq/rest/v19/integrationUsers
Endpoint Parameters	None
HTTP Method	POST
Request Body Parameters	groups	The groups to which the user belongs
Request Body Parameters	oauthClientId	The client ID of the OAuth client that has a one-to-one association with the user
Response Body Parameters	JSON data for the created integration user details.

URI Endpoint Sample

Sample Request Body

Sample Response Body

Update an Integration User

Update an Integration User
Description	This endpoint updates details for an existing integration user.
URI Endpoint	/cpq/rest/v19/integrationUsers/{partyNumber}
Endpoint Parameters	partyNumber	The unique identifier for the user
HTTP Method	PATCH
Request Body Parameters	groups	The groups to which the user belongs
Request Body Parameters	oauthClientId	The client ID of the OAuth client that has a one-to-one association with the user
Response Body Parameters	JSON data with the updated integration user details

URI Endpoint Sample

Sample Request Body

Sample Response Body

Integration Users REST APIs

Overview

Administration

Related Topics