Team user groups endpoint

Team user groups documentation

Fetch all team user groups

team_user_groups(team_id[, params = None])
Parameters:

  • team_id (str or int) – ID of the team

  • params (dict) – (optional) Pagination parameters

Returns:

Collection of team user groups

Example:

groups = client.team_user_groups(7890, {
    "page": 2,
    "limit": 1
})
groups.items[0].group_id # => 1266

Fetch a team user group

team_user_group(team_id, team_user_group_id)
Parameters:

  • team_id (str or int) – ID of the team

  • team_user_group_id (str or int) – ID of the team user group to fetch

Returns:

Team user group model

Example:

group = client.team_user_group(7890, 123)
group.name # => "Demo"
group.permissions['is_admin'] # => True

Create a team user group

create_team_user_group(team_id, params)
Parameters:

  • team_id (str or int) – ID of the team

  • params (dict) – Team user group parameters

Returns:

Team user group model

Example:

group = client.create_team_user_group(7890, {
    "name": "Python group",
    "is_reviewer": True,
    "is_admin": True,
    "admin_rights": ["upload"]
})
group.name # => "Python group"
group.permissions['admin_rights'] # => ["upload"]

Update team user group

update_team_user_group(team_id, team_user_group_id, params)
Parameters:

  • team_id (str or int) – ID of the team

  • team_user_group_id (str or int) – ID of the team user group to update

  • params (dict) – Team user group parameters

Returns:

Team user group model

Example:

group = client.update_team_user_group(7890, 123, {
    "name": "Updated Python group",
    "is_reviewer": False,
    "is_admin": True,
    "admin_rights": ["upload"]
})
group.name # => "Updated Python group"

Delete team user group

delete_team_user_group(team_id, team_user_group_id)

Example:

client.delete_team_user_group(7890, 123)

Add projects to a group

add_projects_to_group(team_id, team_user_group_id, params)
Parameters:

  • team_id (str or int) – ID of the team

  • team_user_group_id (str or int) – ID of the team user group to add projects to

  • params (list or str) – Project IDs to add to the group

Returns:

Team user group model

Example:

group = client.add_projects_to_group(7890, 123, ["123.abc", "345.def"])
"345.def" in group.projects # => True

Remove projects from a group

remove_projects_from_group(team_id, team_user_group_id, params)
Parameters:

  • team_id (str or int) – ID of the team

  • team_user_group_id (str or int) – ID of the team user group to remove projects from

  • params (list or str) – Project IDs to remove from the group

Returns:

Team user group model

Example:

group = client.remove_projects_from_group(7890, 123, ["123.abc", "345.def"])
"345.def" not in group.projects # => True

Add members to a group

add_members_to_group(team_id, team_user_group_id, params)
Parameters:

  • team_id (str or int) – ID of the team

  • team_user_group_id (str or int) – ID of the team user group to add members to

  • params (list or str) – User IDs to add to the group

Returns:

Team user group model

Example:

group = client.add_members_to_group(7890, 123, [421, 187])
421 in group.members # => True

Remove members from a group

remove_members_from_group(team_id, team_user_group_id, params)
Parameters:

  • team_id (str or int) – ID of the team

  • team_user_group_id (str or int) – ID of the team user group to remove members from

  • params (list or str) – User IDs to remove from the group

Returns:

Team user group model

Example:

group = client.remove_members_from_group(7890, 123, [421, 187])
421 not in group.members # => True