Get a list of users mapped to groups in LearnCenter
get
/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/users
Request
Path Parameters
-
groupId: number
Unique identifier of a Group.
-
learnCenterId: number
Unique identifier of LearnCenter.
Query Parameters
-
limit(optional): integer
Specifies how many items should be returned in a payload. Must be lower than server default limit size.
-
offset(optional): integer
Specify the starting point of the response.Default Value:
0
-
totalResults(optional): boolean
If set to true, the payload includes the total number of rows that satisfies the request. The use of this parameter determines if the 'last' link is displayed for a pageable collection.
Response
Supported Media Types
- application/json
200 Response
Group users collection fetched.
Root Schema : GroupUsersResponse
Type:
object
Group users response object.
Show Source
-
count(optional):
number
Count is the current number of records displayed in the response.
-
hasMore(optional):
boolean
True indicates that we have more records to be displayed.
-
items(optional):
object GroupUserResponse
Response object for group user mappings.
-
limit(optional):
number
Limit implies the maximum number of records which can be displayed in the page.
-
links(optional):
array links
Example:
{
"items":[
{
"groupId":1232,
"group":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178942/groups/1232"
}
]
},
"userId":1120778,
"user":{
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/users/1120778"
}
]
},
"statusFlag":true,
"excludeFlag":false,
"links":[
{
"rel":"canonical",
"href":"https://{url}/learn.rest/v1/learnCenters/178942/groups/1232/users/1120778"
}
]
},
{
"...":null
}
],
"limit":100,
"count":1,
"hasMore":false,
"links":[
{
"rel":"canonical",
"href":"..learnCenters/178942/groups/1232/users"
}
]
}
Nested Schema : GroupUserResponse
Type:
object
Response object for group user mappings.
Show Source
-
excludeFlag(optional):
boolean
You can manually exclude Users from Dynamic Groups so that they are never automatically included even if they match the conditions for becoming members of the Dynamic Group.
-
group(optional):
object group
Details of the group being mapped.
-
groupId(optional):
number
Id of the group.
-
links(optional):
array links
Link to the Group Users.
-
statusFlag(optional):
boolean
Status of the Group. Enum for statusFlag are: active, inactive.
-
user(optional):
object user
The user object used for group user mappings.
-
userId(optional):
number
Id of the user in the group.
Nested Schema : links
Type:
array
Link to the Group Users.
Show Source
-
Array of:
object GroupUserLinkItem
Object comprising links to the users in the group.
Nested Schema : GroupLinkItem
Type:
object
Link to a group item.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}
Nested Schema : GroupUserLinkItem
Type:
object
Object comprising links to the users in the group.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/users/112867"
}
Nested Schema : links
Type:
Show Source
array
-
Array of:
object UserLinkItem
Object of the User Link Item.
Nested Schema : UserLinkItem
Type:
object
Object of the User Link Item.
Show Source
-
href(optional):
string
Example:
{url}/learn.rest/v1/users/456
-
rel(optional):
string
Example:
canonical
Example:
{
"rel":"canonical",
"href":"{url}/learn.rest/v1/users/456"
}
401 Response
500 Response
Internal server error.