Get All Users of a Group
get
/rest/v19/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 : 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 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 -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/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/v19/companies/_host/groups/group1/users"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/companies/_host/groups/group1/users?offset=0&limit=1000"
}
]
}