Api access groups
/team/:teamid/groups (authenticated)
Get the groups available for a given team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
{
// The group ID
id: number,
// The group name
name: string,
}
/team/:teamid/group/:groupid (authenticated)
Delete a group
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
groupid: undocumented
/team/:teamid/group (authenticated)
Add a new group to a team
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
{
// name of the new group
The: string,
}
teamid: The id of the team to act on
/team/:teamid/group/:groupid (authenticated)
Update a team group
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
{
// The group name
name: string,
}
teamid: The id of the team to act on
groupid: undocumented
/team/:teamid/group/:groupid/permission/:permissionid (authenticated)
Add a permission to a group
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
groupid: undocumented
permissionid: undocumented
/team/:teamid/group/:groupid/permission/:permissionid (authenticated)
Remove a permission from a group
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
groupid: undocumented
permissionid: undocumented
/team/:teamid/group/:groupid/permissions (authenticated)
Get the permissions for a given group
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
groupid: undocumented
{
// The name of the permission
name: string,
// The permission description
description: string,
}
/team/:teamid/group/:groupid/members (authenticated)
Get the members of a given group
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
groupid: undocumented
/team/:teamid/group/:groupid/user/:userid (authenticated)
Set the group for a given user
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
Required Team Permissions
- admin
teamid: The id of the team to act on
groupid: undocumented
userid: undocumented
/permissions (authenticated)
Get all permissions available
Note:Requires sending an authentication token either in the sessionid query argument,
or in the X-API-Key header. The token is returned from the login route.
{
// The ID of the permission
id: number,
// The permission name
name: string,
// The permission description
description: string,
}