Users REST APIs

Oracle CPQ 25A introduces new User web service REST API calls that no longer mandate a company be specified for the endpoint. This new endpoint simplifies the management of users on the site by providing a single static endpoint that can be used to update users across all companies. System Integrators no longer need to make separate calls to the Host Company and each Partner Company to manage those users.

The following lists the new company-agnostic Oracle CPQ 25A User REST APIs endpoints which include a new auto-generated partyNumber user identification parameter.

Get All Users Across Companies

Use this endpoint to retrieve a list of all users.

  • Endpoint:  /rest/v18/users
  • Method:  GET

Get a User

Use this new endpoint to retrieve a single user’s information.

  • Endpoint:  /rest/v18/users/{partyNumber}
  • Method:  GET

Create a User

Use this endpoint to create a new user.

  • Endpoint:  /rest/v18/users
  • Method:  POST

Update a User

Use this endpoint to update an existing user.

  • Endpoint:  /rest/v18/users/{partyNumber}
  • Method:  PATCH

Import Users

Use this endpoint to import users for a site as designated in a zip file.

  • Endpoint:  /rest/v18/actions/import
  • Method:  POST

Get All User Groups for a User

Use this endpoint to retrieve user groups for a given user.

  • Endpoint:  /rest/v18/users/{partyNumber}/groups
  • Method:  GET

Update User Groups for a User

Use this endpoint to update user groups for a given user.

  • Endpoint:  /rest/v18/users/{partyNumber}/groups
  • Method:  PUT

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Tips And Considerations

  • User REST APIs for the existing company-specified endpoints and SCIM-Compliant user endpoints continue to be supported.
  • The Get Users Based on Company REST API will include the partyId and partyNumber parameters in the payload response.
  • Beginning in Oracle CPQ 25A for naming clarity, the parameter isSuperUserPermEnabled is renamed isUserAdminPermEnabled. Refer to  Application Administrator Permission.