Group
This endpoint will return the users with details and permission for a group
Authorizations
Path parameters
group_idintegerRequired
ID of the group to retrieve users and their details
Responses
200
After a successful request, the endpoint returns HTTP 200.
application/json
401
Authorization information is missing or invalid.
403
If non-admin user or non-group member tries to call this endpoint, the call is rejected with 403 Forbidden.
404
If group is not found with the provided id, the endpoint returns HTTP 404.
422
Invalid group_id is provided.
get
GET /api/public/v1/groups/{group_id}/users HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*
{
"group_users": [
{
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text",
"permission": "text"
}
]
}
This endpoint will update the users and their permissions for a group
Authorizations
Path parameters
group_idintegerRequired
ID of the group to update users and their permissions
Body
List of operations to perform
actionstring · enumRequiredPossible values:
Type of action to perform
user_idintegerRequired
ID of the user to perform the action on
permissionstring · enumOptionalPossible values:
Permission to set for the user when action is add or update
Responses
200
After a successful request, the endpoint returns HTTP 200.
application/json
401
Authorization information is missing or invalid.
403
If non-admin user tries to call this endpoint, the call is rejected with 403 Forbidden.
404
If group is not found with the provided id, the endpoint returns HTTP 404.
422
Invalid group_id or changes are provided.
post
POST /api/public/v1/groups/{group_id}/users/batch_update HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53
[
{
"action": "add",
"user_id": 1,
"permission": "manager"
}
]
{
"group_users": [
{
"id": 1,
"full_name": "text",
"display_name": "text",
"email": "text",
"permission": "text"
}
]
}
Last updated
Was this helpful?