Get All Users of a Group
get
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/users
This endpoint retrieves a list of all users of a group.
Request
Path Parameters
-
companyLoginName(required): string
Company login name.
-
groupVarName(required): string
Group variable 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" ]
-
fields: string
User fields to be returned in response.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of fields to order the response by.
-
q: string
Criteria to filter the group users. By default no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
List of users for a group.
Root Schema : user-collection
Type:
Show Source
object
-
items:
array List of users
Title:
List of users
List of users
Nested Schema : user
Type:
Show Source
object
-
accessPermissions:
object Access Permissions
Title:
Access Permissions
Access Permissions of a user -
approvalDelegate:
string
Title:
Approval Delegate
Approval Delegate -
billAddress1:
string
Title:
Billing Address 1
Billing Address 1 -
billAddress2:
string
Title:
Billing Address 2
Billing Address 2 -
billCity:
string
Title:
Billing City
Billing City -
billCompany:
string
Title:
Billing Company
Billing Company -
billCompany2:
string
Title:
Billing Company 2
Billing Company 2 -
billCountry:
string
Title:
Billing Country
Billing Country -
billEmail:
string
Title:
Billing Email
Billing Email -
billFax:
string
Title:
Billing Fax
Billing Fax -
billFirstName:
string
Title:
Billing First Name
Billing First Name -
billLastName:
string
Title:
Billing Last Name
Billing Last Name -
billPhone:
string
Title:
Billing Phone
Billing Phone -
billStateProvince:
string
Title:
Billing State
Billing State -
billZip:
string
Title:
Billing Zip
Billing Zip -
company:
object Company details
Title:
Company details
User Company details. Applicable only for Users Across Companies -
currency:
object Currency
Title:
Currency
Currency preference of user. Value holds currency code -
dateAdded:
string
Title:
Date Added
User creation date -
dateFormat:
object Date Format
Title:
Date Format
User preferred date time format -
dateModified:
string
Title:
Date Modified
User modified date -
email:
string
Title:
Email
Email of the user -
enabledForSso:
object Enabled For SSO
Title:
Enabled For SSO
Enabled For SSO -
externalSsoId:
string
Title:
External SSO Id
External SSO Id -
fax:
string
Title:
Fax Number
Fax of the user -
firstName:
string
Title:
First Name
First Name of the user -
groups:
object Groups
Title:
Groups
Groups to which the user belongs -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission Enabled
Access Admin Permission Enabled -
isMobileEnabled:
boolean
Title:
Is Mobile Enabled
Is Mobile Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference Email
Is notification preference email -
isNotifyFax:
boolean
Title:
Is Notification Preference Fax
Is notification preference fax -
isProxyPermEnabled:
boolean
Title:
Proxy Permission Enabled
Proxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission Enabled
Is Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services Only
Web Services Only -
jobTitle:
string
Title:
Job Title
Job Title of the user -
language:
object Language
Title:
Language
Language preference of user. Value holds language code -
lastLogin:
string
Title:
Last Login Date
User last loggedin date -
lastName:
string
Title:
Last Name
Last Name of the user -
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects -
login:
string
Title:
Login Id
Login Id of the user -
numberFormat:
object Number Format
Title:
Number Format
Preferred number format of user -
partnerLogin:
string
Title:
Partner Login
Partner Login -
phone:
string
Title:
Phone Number
Phone number of the user -
separateShipAddr:
boolean
Title:
Seperate Ship Address
Seperate Ship Address -
shipAddress1:
string
Title:
Shipping Address 1
Shipping Address 1 -
shipAddress2:
string
Title:
Shipping Address 2
Shipping Address 2 -
shipCity:
string
Title:
Shipping City
Shipping City -
shipCompany:
string
Title:
Shipping Company
Shipping Company -
shipCompany2:
string
Title:
Shipping Company 2
Shipping Company 2 -
shipCountry:
string
Title:
Shipping Country
Shipping Country -
shipEmail:
string
Title:
Shipping Email
Shipping Email -
shipFax:
string
Title:
Shipping Fax
Shipping Fax -
shipFirstName:
string
Title:
Shipping First Name
Shipping First Name -
shipLastName:
string
Title:
Shipping Last Name
Shipping Last Name -
shipPhone:
string
Title:
Shipping Phone
Shipping Phone -
shipStateProvince:
string
Title:
Shipping State
Shipping State -
shipZip:
string
Title:
Shipping Zip
Shipping Zip -
status:
object Status
Title:
Status
Status of the user -
timeZone:
object TimeZone of user
Title:
TimeZone of user
User preferred timezone -
type:
object Type
Title:
Type
Type of the user -
units:
object Units
Title:
Units
User preferred units
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
-
loginName:
string
Title:
Company Login Name
Company Login Name -
name:
string
Title:
Company Name
Company Name
Nested Schema : Currency
Type:
object
Title:
Currency
Currency preference of user. Value holds currency code
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Date Format
Type:
object
Title:
Date Format
User preferred date time format
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Enabled For SSO
Type:
object
Title:
Enabled For SSO
Enabled For SSO
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Language
Type:
object
Title:
Language
Language preference of user. Value holds language code
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
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
Nested Schema : Number Format
Type:
object
Title:
Number Format
Preferred number format of user
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Status
Type:
object
Title:
Status
Status of the user
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : TimeZone of user
Type:
object
Title:
TimeZone of user
User preferred timezone
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : Type
Type:
object
Title:
Type
Type of the user
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
string
Title:
Value
Value
Nested Schema : Units
Type:
object
Title:
Units
User preferred units
Show Source
-
displayValue:
string
Title:
Display Value
Display value. -
value:
number
Title:
Value
Value
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Access Permission
Title:
Access Permission
User access bits information
Nested Schema : Access Permission
Type:
object
Title:
Access Permission
User access bits information
Show Source
-
hasAccess:
boolean
Title:
Has Access
Boolean attribute that indicates if a user has access to the restricted entity. -
name:
string
Title:
Restricted Entity Name
Name of the entity to which access restrictions apply -
type:
string
Title:
Type
Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder -
variableName:
string
Title:
Restricted Entity Variable Name
Variable name of the entity to which access restrictions apply
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Group
Title:
Group
User group information
Nested Schema : Group
Type:
object
Title:
Group
User group information
Show Source
-
label:
string
Title:
Group Name
Group name -
type:
string
Title:
Group Type
Type of the group -
variableName:
string
Title:
Group Variable Name
Variable name of the 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
Examples
The following example retrieves a list of all users of a group by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/companies/visionServices/group/midwestTestGroup/users
Response Body Sample
{ "items": [{ "login": "amayor", "firstName": "Alex", "lastName": "Mayor" }, { "login": "msmith", "firstName": "Matt", "lastName": "Smith" }, { "login": "ljones", "firstName": "Lisa", "lastName": "Jones" } ], "offset": 0, "limit": 1000, "count": 3, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/companies/_host/groups/group1/users" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/companies/_host/groups/group1/users?offset=0&limit=1000" } ] }