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

Get All Users

get

/rest/v16/users

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

Request

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 no.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.
  • 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

This endpoint returns all users accessible to the current user by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL. 

curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" 
https://sitename.oracle.com/rest/v16/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

Expand all users with groups details.

https://sitename.oracle.com/rest/v16/users?expand=groups

Expand all users with access permission, if Administration Groups are disabled.

https://sitename.oracle.com/rest/v16/users?expand=accessPermissions

Return all host company users.

https://sitename.oracle.com/rest/v16/users?q={"company.loginName":"_host"}

Return all users of a partner organization.

https://sitename.oracle.com/rest/v16/users?q={"company.loginName”:"po1"}

Return all active users sorted by company name.

https://sitename.oracle.com/rest/v16/users?q={"status":1}&orderby=company.name

Return all active users of a partner organization sorted by user type.

https://sitename.oracle.com/rest/v16/users?q={"$and":[{"company.loginName":"po1"}, {"status":1}]}&orderby=type

Return all active users of a partner organization and BUY_ACCESS user type.

Return all active users of a partner organization and BUY_ACCESS user type.

Return all active users of a partner organization sorted by company name and user type.

https://sitename.oracle.com/rest/v16/users?q={"$and":[{"company.loginName":"po1"}, {"status":1}]}

The user's listed in the response varies depending on the current logged in user access permissions and groups. If the Logged In user is:

BigMachines (_internal) company user - The return only contains users from _internal company

  • If the user is a Support Type user - The return only contains Support Users.
  • If the user is not Support Type user - The return contains all the users from _internal company.

Partner Organization company user - the return only contains users from the logged in user's Partner Organization.

  • If the user is a Full Access user without User Administration permissions, the return only contains the logged in user.
  • If the user is a Full Access user with User Administration permissions, the return contains all users from the user's Partner Organization.

_Host company users with Admin Groups enabled, and

  • Internal Users and Partner Organization segments disabled - The return doesn't return any users, returns an error.
  • Internal Users enabled and Partner Organization segments disabled - The return lists all users from the Host company
  • If the user is a Full Access user without User Administration permissions, Internal Users disabled, and Partner Organization segments enabled - The return doesn't return any users, returns an error.
  • If the user is a Full Access user with User Administration permissions, Internal Users disabled, and Partner Organization segments enabled – The return lists all users from all Partner Organizations
  • If the user is a Full Access user without User Administration permissions, Internal Users and Partner Organization segments enabled – The return lists only Host company users.
  • If the user is a Full Access user with User Administration permissions, Internal Users and Partner Organization segments enabled – The return lists all users from Host company and all Partner Organizations.

_Host company users with Admin Groups disabled, and

  • If the user is a Full Access user with User Admin permissions – The return lists all users from Host company and all Partner Organizations.
  • If the user is a Full Access user without User Admin permissions – The return only contains the logged in user.

Response Body Sample

{
  "items": [{
      "login": "simon.watts",
      "isNotifyFax": false,
      "firstName": "Simon",
      "lastName": "Watts",
      "jobTitle": "Sales Manager",
      "email": "simon.watts_eczw@companyemail.com",
      "phone": "262-262-2627",
      "fax": "262-265-2655",
      "billCountry": "United States",
      "shipCountry": "United States",
      "shipFax": "262 265 2655",
      "partnerLogin": "john.dunbar",
      "externalSsoId": "simon.watts_eczw@companyemail.com",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isWebServicesOnly": false,
      "dateModified": "2020-10-13T16:28:47.000Z",
      "dateAdded": "2018-05-07T14:15:45.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/simon.watts"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/simon.watts/groups"
        }
      ],
      "lastLogin": "2018-05-07T15:23:58.000Z",
      "type": {
        "value": "SALES_AGENT",
        "displayValue": "SalesAgent"
      },
      "language": {
        "value": "en_US",
        "displayValue": "English"
      },
      "currency": {
        "value": "GBP",
        "displayValue": "United Kingdom Pound"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/New_York",
        "displayValue": "(GMT-5:00 GMT-4:00) New York"
      },
      "units": {
        "value": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 2,
        "displayValue": "dd/MM/yyyy HH:mm"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "enabledForSso": {
        "value": "SSO_ENABLED",
        "displayValue": "Enabled for SSO"
      },
      "company": {
        "name": "abcCo",
        "loginName": "_host"
      }
    }, {
      "login": "takahiro.tayama",
      "isNotifyFax": false,
      "firstName": "Takahiro",
      "lastName": "Tayama",
      "jobTitle": "営業部長",
      "email": "takahiro.tayama_eczw@companyemail.com",
      "phone": "011-98-7-6543-2103",
      "fax": "011-98-7-6543-2102",
      "shipFax": "011-98-7-6543-2102",
      "partnerLogin": "john.dunbar",
      "externalSsoId": "takahiro.tayama_eczw@companyemail.com",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isWebServicesOnly": false,
      "dateModified": "2020-10-13T16:28:47.000Z",
      "dateAdded": "2018-05-07T14:15:45.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/takahiro.tayama"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/takahiro.tayama/groups"
        }
      ],
      "lastLogin": "2018-05-07T15:24:34.000Z",
      "type": {
        "value": "SALES_AGENT",
        "displayValue": "SalesAgent"
      },
      "language": {
        "value": "ja_JP",
        "displayValue": "Japanese [Japan]"
      },
      "currency": {
        "value": "JPY",
        "displayValue": "Japanese Yen"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/New_York",
        "displayValue": "(GMT-5:00 GMT-4:00) New York"
      },
      "units": {
        "value": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 2,
        "displayValue": "dd/MM/yyyy HH:mm"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "enabledForSso": {
        "value": "SSO_ENABLED",
        "displayValue": "Enabled for SSO"
      },
      "company": {
        "name": "abcCo",
        "loginName": "_host"
      }
    }, {
      "login": "taro.hiraiwa",
      "isNotifyFax": false,
      "firstName": "Taro",
      "lastName": "Hiraiwa",
      "jobTitle": "営業担当者",
      "email": "taro.hiraiwa_eczw@companyemail.com",
      "phone": "011-98-7-6543-2101",
      "fax": "011-98-7-6543-2100",
      "shipFax": "011-98-7-6543-2100",
      "partnerLogin": "john.dunbar",
      "externalSsoId": "taro.hiraiwa_eczw@companyemail.com",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isWebServicesOnly": false,
      "dateModified": "2020-10-13T16:28:48.000Z",
      "dateAdded": "2018-05-07T14:15:45.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/taro.hiraiwa"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/taro.hiraiwa/groups"
        }
      ],
      "lastLogin": "2018-05-07T15:25:13.000Z",
      "type": {
        "value": "SALES_AGENT",
        "displayValue": "SalesAgent"
      },
      "language": {
        "value": "ja_JP",
        "displayValue": "Japanese [Japan]"
      },
      "currency": {
        "value": "JPY",
        "displayValue": "Japanese Yen"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/New_York",
        "displayValue": "(GMT-5:00 GMT-4:00) New York"
      },
      "units": {
        "value": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 2,
        "displayValue": "dd/MM/yyyy HH:mm"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "enabledForSso": {
        "value": "SSO_ENABLED",
        "displayValue": "Enabled for SSO"
      },
      "company": {
        "name": "abcCo",
        "loginName": "_host"
      }
    }, {
      "login": "wei.wang",
      "isNotifyFax": false,
      "firstName": "Wei",
      "lastName": "Wang",
      "jobTitle": "销售代表",
      "email": "wei.wang_eczw@companyemail.com",
      "phone": "262-262-2627",
      "fax": "262-265-2655",
      "shipFax": "262 265 2655",
      "partnerLogin": "john.dunbar",
      "externalSsoId": "wei.wang_eczw@companyemail.com",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isWebServicesOnly": false,
      "dateModified": "2020-10-13T16:28:48.000Z",
      "dateAdded": "2018-05-07T14:15:46.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/wei.wang"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/wei.wang/groups"
        }
      ],
      "lastLogin": "2018-05-07T15:26:22.000Z",
      "type": {
        "value": "SALES_AGENT",
        "displayValue": "SalesAgent"
      },
      "language": {
        "value": "zh_CN",
        "displayValue": "Chinese (Simplified) [China]"
      },
      "currency": {
        "value": "CNY",
        "displayValue": "Chinese Yuan Renminbi"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/New_York",
        "displayValue": "(GMT-5:00 GMT-4:00) New York"
      },
      "units": {
        "value": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 2,
        "displayValue": "dd/MM/yyyy HH:mm"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "enabledForSso": {
        "value": "SSO_ENABLED",
        "displayValue": "Enabled for SSO"
      },
      "company": {
        "name": "abcCo",
        "loginName": "_host"
      }
    }, {
      "login": "colby.morris",
      "isNotifyFax": false,
      "firstName": "Colby",
      "lastName": "Morris",
      "jobTitle": "Channel Account Manager",
      "email": "colby.morris_zenh@companyemail.com",
      "phone": "13105555237",
      "fax": "13105555239",
      "shipFax": "13105555239",
      "partnerLogin": "john.dunbar",
      "externalSsoId": "colby.morris_zenh@companyemail.com",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isWebServicesOnly": false,
      "dateModified": "2020-10-13T16:28:49.000Z",
      "dateAdded": "2018-05-07T14:15:39.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/colby.morris"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/colby.morris/groups"
        }
      ],
      "lastLogin": "2018-11-22T09:30:10.000Z",
      "type": {
        "value": "SALES_AGENT",
        "displayValue": "SalesAgent"
      },
      "language": {
        "value": "en_US",
        "displayValue": "English"
      },
      "currency": {
        "value": "USD",
        "displayValue": "US Dollar"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/New_York",
        "displayValue": "(GMT-5:00 GMT-4:00) New York"
      },
      "units": {
        "value": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 0,
        "displayValue": "MM/dd/yyyy h:mm a"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "enabledForSso": {
        "value": "SSO_ENABLED",
        "displayValue": "Enabled for SSO"
      },
      "company": {
        "name": "abcCo",
        "loginName": "_host"
      }
    },
   ...
  ],
  "offset": 0,
  "limit": 1000,
  "count": 61,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/users"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/users?offset=0&limit=1000"
    }
  ]
}
Back to Top