Some functionality in the TinQwise learning platform is only available to users with additional permissions, see User roles.
Permissions allow users to see progression reports. For what those reports look like, see Creating a progression report and Progression reports for reporting managers in LXP.
There are two ways to assign them through the API:
User group permissions give a single user a permission on a target group.
Group group permissions give a whole group the same permission on a target group.
Part of Web API v3 for user management. You need a token with the v3:permissions:read or v3:permissions:write scope, see Authenticating with the Web API v3.
đ§ Be careful
It is currently not possible to give users sub-admin permissions through the API. This must be done manually through Control, see Create an Admin (restricted access) group in TinQwise Control.
Available permissions
The permission name is one of manage_group, view_members, manage_members, reporting, post_status or manage_status.
To enable reporting access to a group of users, the user or group needs to get the manage_members, view_members and reporting permissions on a target group.
To enable the use of the social timeline, set:
post_statusfor the post status update in this group permission.manage_statusfor the Manage statuses for this and all underlying groups permission.
User group permissions
Use these endpoints to give a permission to a single user.
Retrieving user group permissions
Use the GET /api/v3/public/user_group_permissions/ endpoint to retrieve a list of all user group permissions.
Field | Description |
| The uuid of the group. |
| The uuid of the user. |
| The name of the permission. |
Creating user group permissions
POST a user UUID, a group UUID and a permission name to /api/v3/public/user_group_permissions/.
Modifying user group permissions
Permissions can not be modified, only created and deleted.
Deleting user group permissions
Send a DELETE to /api/v3/public/user_group_permissions/{group_uuid}/{user_uuid}/{permission}/ to revoke a permission for a user.
Group group permissions
Use these endpoints to give a permission to a whole group of users at once, so they all get the same permissions.
Retrieving group group permissions
Use the GET /api/v3/public/group_group_permissions/ endpoint to retrieve a list of all group group permissions.
Field | Description |
| The uuid of the group that has the permission over the group. |
| The uuid of the target group of the permission. |
| The name of the permission. |
Creating group group permissions
POST a source_group_uuid, a target_group_uuid and a permission name to /api/v3/public/group_group_permissions/.
Modifying group group permissions
Permissions can not be modified, only created and deleted.
Deleting group group permissions
Send a DELETE to /api/v3/public/group_group_permissions/{source_group_uuid}/{target_group_uuid}/{permission}/ to revoke a permission for a group.