Get All Across Companies

get

/rest/v19/users

Gets list of users across companies as JSON 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 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.
  • 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 : Users
Type: object
Title: Users
All users of a group
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : User Details
Type: object
Title: User Details
User details of group.
Show Source
Back to Top

Examples

The following example returns a list of users across companies 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": [{
      "login": "guest",
      "isNotifyFax": false,
      "firstName": "Lisa",
      "lastName": "Jones",
      "email": "ljones@yourcompany.com",
      "phone": "+1 (366) 942-5555 (Land)",
      "isNotifyEmail": false,
      "partyId": 100010025532024,
      "partyNumber": "100010025532024",
      "dateModified": "2024-03-08T23:11:11.000Z",
      "dateAdded": "2008-05-05T17:27:57.000Z",
      "links": [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/users/100010025532024"
        }, {
          "rel": "child",
          "href": "http://sitename.oracle.com/rest/v19/users/100010025532024/groups"
        }
      ],
      "type": {
        "value": "RESTRICTED_ACCESS",
        "displayValue": "RestrictedAccess"
      },
      "language": {
        "value": "en_US",
        "displayValue": "English"
      },
      "currency": {
        "value": "USD",
        "displayValue": "US Dollar"
      },
      "numberFormat": {
        "value": 0,
        "displayValue": "####.##"
      },
      "timeZone": {
        "value": "America/Los_Angeles",
        "displayValue": "(GMT-8:00 GMT-7:00) Los Angeles"
      },
      "units": {
        "value": 0,
        "displayValue": "System Default"
      },
      "dateFormat": {
        "value": 0,
        "displayValue": "MM/dd/yyyy h:mm a"
      },
      "status": {
        "value": 1,
        "displayValue": "Active"
      },
      "company": {
        "name": "po1",
        "loginName": "po1"
      }
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 1000,
  "hasMore": true,
  "links": [{
      "rel": "canonical",
      "href": "http://sitename.oracle.com/rest/v19/users"
    }, {
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/users?offset=0&limit=1000"
    }, {
      "rel": "next",
      "href": "http://sitename.oracle.com/rest/v19/users?offset=1000&limit=1000"
    }
  ]
}
Back to Top