1. REST API Services for Oracle CPQ
  2. Tasks
  3. User Management

Get All Company Users

get

/rest/v16/companies/{companyName}/users

This endpoint returns a list of users for the specified company as JSON data or as a Zip file depending on Accept type passed in the request header.

Request

Path Parameters
  • Company login name. For Host Company users, use _host. For Partner Organization users, use partner organization company login name.
Query Parameters
  • Exclude given link types from response. Supported only with produces type application/json.
    Allowed Values: [ "self", "child", "parent", "canonical", "next", "prev", "related" ]
  • Allows expansion of relationships. Supported only with produces type application/json.
    Allowed Values: [ "groups", "accessPermissions" ]
  • User fields to be returned in response. Supported only with produces type application/json.
  • Specifies the number of records to be fetched. Supported only with produces type application/json.
  • Spefifies the starting point from which records to be fetched. Supported only with produces type application/json.
  • Specifies a comma-separated list of fields to order the response by. Supported only with produces type application/json.
  • Criteria to filter the users. By default no filtering is applied. Supported only with produces type application/json.
  • Specifies if the total record to be included in response or not. Supported only with produces type application/json.
Back to Top

Response

Supported Media Types

Default Response

List of users.
Body ()
Root Schema : user-collection
Type: object
Show Source
Nested Schema : List of users
Type: array
Title: List of users
List of users
Show Source
Nested Schema : user
Type: object
Show Source
Nested Schema : Access Permissions
Type: object
Title: Access Permissions
Access Permissions of a user
Show Source
Nested Schema : Company details
Type: object
Title: Company details
User Company details. Applicable only for Users Across Companies
Show Source
Nested Schema : Currency
Type: object
Title: Currency
Currency preference of user. Value holds currency code
Show Source
Nested Schema : Date Format
Type: object
Title: Date Format
User preferred date time format
Show Source
Nested Schema : Enabled For SSO
Type: object
Title: Enabled For SSO
Enabled For SSO
Show Source
Nested Schema : Groups
Type: object
Title: Groups
Groups to which the user belongs
Show Source
Nested Schema : Language
Type: object
Title: Language
Language preference of user. Value holds language code
Show Source
Nested Schema : Number Format
Type: object
Title: Number Format
Preferred number format of user
Show Source
Nested Schema : Status
Type: object
Title: Status
Status of the user
Show Source
Nested Schema : TimeZone of user
Type: object
Title: TimeZone of user
User preferred timezone
Show Source
Nested Schema : Type
Type: object
Title: Type
Type of the user
Show Source
Nested Schema : Units
Type: object
Title: Units
User preferred units
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Access Permission
Type: object
Title: Access Permission
User access bits information
Show Source
  • Title: Has Access
    Boolean attribute that indicates if a user has access to the restricted entity.
  • Title: Restricted Entity Name
    Name of the entity to which access restrictions apply
  • Title: Type
    Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder
  • Title: Restricted Entity Variable Name
    Variable name of the entity to which access restrictions apply
Nested Schema : items
Type: array
Show Source
Nested Schema : Group
Type: object
Title: Group
User group information
Show Source
Back to Top

Examples

The following example shows how to returns all users for the specified company accessible to the current user by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL. 

curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" 
https://sitename.oracle.com/rest/v16/companies/abcCo/users
  • To return a JSON object, set the Accept header to 'application/json'
  • To return a Zip file, set the Accept header to 'application/zip'

Query Examples:

Return all users in host company.

https://sitename.oracle.com/rest/v16/companies/_host/users

Return all active users in A1BM1 company.

https://sitename.oracle.com/rest/v16/companies/A1BM1/users?q={"status":1}

Response Body Sample

 {
  "items": [{
      "dateModified": "2019-12-16T11:18:53.000Z",
      "dateAdded": "2012-10-08T16:56:31.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/companies/abcCo/users/jjones"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/abcCo/users/jjones/groups"
        }
      ],
      "login": "jjones",
      "firstName": "John",
      "lastname": "Jones",
      "email": "john.jones@abcCo.com",
      "lastLogin": "2019-08-06T19:39:01.000Z",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isNotifyFax": false,
      "isSuperUserPermEnabled": true,
      "isWebServicesOnly": false,
      "isAccessAdminPermEnabled": true,
      "isProxyPermEnabled": true,
      "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": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 0,
        "displayValue": "MM/dd/yyyy h:mm a"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "enabledForSso": {
        "value": "NOT_ENABLED",
        "displayValue": "Not Enabled"
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 118,
  "hasMore": false,
  "totalResults": 173
}
Back to Top