Group
This endpoint will return the users with details and permission for a group
ID of the group to retrieve users and their details
After a successful request, the endpoint returns HTTP 200.
Authorization information is missing or invalid.
If non-admin user or non-group member tries to call this endpoint, the call is rejected with 403 Forbidden.
If group is not found with the provided id, the endpoint returns HTTP 404.
Invalid group_id is provided.
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
ID of the group to update users and their permissions
List of operations to perform
Type of action to perform
ID of the user to perform the action on
Permission to set for the user when action is add or update
After a successful request, the endpoint returns HTTP 200.
Authorization information is missing or invalid.
If non-admin user tries to call this endpoint, the call is rejected with 403 Forbidden.
If group is not found with the provided id, the endpoint returns HTTP 404.
Invalid group_id or changes are provided.
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?