REST API Services for Oracle CPQ

Get All Company Users

get

/rest/v19/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

companyName(required): string

Company login name. For Host Company users, use _host. For Partner Organization users, use partner organization company login name.

Query Parameters

excludeLinks: string

Exclude given link types from response. Supported only with produces type application/json.

Allowed Values: [ "self", "child", "parent", "canonical", "next", "prev", "related" ]
expand: string

Allows expansion of relationships. Supported only with produces type application/json.

Allowed Values: [ "groups", "accessPermissions" ]
fields: string

User fields to be returned in response. Supported only with produces type application/json.
limit: integer

Specifies number of records to be fetched. Supported only with produces type application/json.
offset: integer

Spefifies the starting point from which records to be fetched. Supported only with produces type application/json.
orderby: string

Specifies a comma-separated list of fields to order the response by. Supported only with produces type application/json.
q: string

Criteria to filter the users. By default no filtering is applied. Supported only with produces type application/json.
totalResults: boolean

Specifies if the total record to be included in response or not. Supported only with produces type application/json.

Response

Supported Media Types

application/json
application/zip

Default Response

List of users.

Root Schema : Users

Type: object

Title: Users

All users of a group

Show Source

items: array items
links: array Links

Title: Links

Links to the related objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/user"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Users",
    "description":"All users of a group"
}

Nested Schema : items

Type: array

Show Source

Array of: object User Details

Title: User Details

User details of group.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/user"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to the related objects.

Show Source

Array of: object reference links

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to the related objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : User Details

Type: object

Title: User Details

User details of group.

Show Source

firstName: string

Title: User First Name

First name of the user.
lastName: string

Title: User Last Name

Last name of the user.
login: string

Title: User Login Id

Login Id of the user.

{
    "type":"object",
    "properties":{
        "login":{
            "type":"string",
            "description":"Login Id of the user.",
            "title":"User Login Id"
        },
        "firstName":{
            "type":"string",
            "description":"First name of the user.",
            "title":"User First Name"
        },
        "lastName":{
            "type":"string",
            "description":"Last name of the user.",
            "title":"User Last Name"
        }
    },
    "title":"User Details",
    "description":"User details of group."
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

href: string

Title: URL to the related object

URL to the related object
name: string
rel: string

Title: Link Relationship to the current object

Default Value: self

Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object",
            "default":"self"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        },
        "name":{
            "type":"string"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Examples

The following example returns all users for the specified company accessible to the current user as JSON or as a Zip file depending on Accept type passed in the request header by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/users

Response Body Sample

{
  "items": [{
      "dateModified": "2024-12-16T11:18:53.000Z",
      "dateAdded": "2012-10-08T16:56:31.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/companies/abcCo/users/jjones"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v19/companies/abcCo/users/jjones/groups"
        }
      ],
      "login": "jjones",
      "firstName": "John",
      "lastname": "Jones",
      "email": "john.jones@abcCo.com",
      "lastLogin": "2024-08-06T19:39:01.000Z",
      "separateShipAddr": false,
      "isNotifyEmail": true,
      "isNotifyFax": false,
      "isUserAdminPermEnabled": 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
}