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:
objectTitle:
UsersAll users of a group
Show Source
-
items:
array items
-
links:
array Links
Title:
LinksLinks to the related objects.
Nested Schema : items
Type:
Show Source
array-
Array of:
object User Details
Title:
User DetailsUser details of group.
Nested Schema : Links
Type:
arrayTitle:
LinksLinks to the related objects.
Show Source
-
Array of:
object reference links
Title:
reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : User Details
Type:
objectTitle:
User DetailsUser details of group.
Show Source
-
firstName:
string
Title:
User First NameFirst name of the user. -
lastName:
string
Title:
User Last NameLast name of the user. -
login:
string
Title:
User Login IdLogin Id of the user.
Nested Schema : reference links
Type:
objectTitle:
reference linksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current objectDefault Value:selfLink Relationship to the current object
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
}