components.group.api

API for Django Groups

components.group.api.get_all_groups()

Return all Groups.

Returns:List of Groups
components.group.api.get_all_groups_by_list_id(list_groups_ids)

Get all groups by the given list of group ids.

Parameters:list_groups_ids

Returns:

components.group.api.get_all_groups_except_list(list_group)

Get all groups except the given list of groups.

Parameters:list_group

Returns:

components.group.api.get_all_groups_except_list_id(list_groups_ids)

Get all groups except the given list of group ids.

Parameters:list_groups_ids

Returns:

components.group.api.get_anonymous_group()

Get anonymous group of users.

Returns:

components.group.api.get_by_name_and_permission(name, permission_codename)

Get a group by name and permission codename.

Parameters:
  • name
  • permission_codename

Returns:

components.group.api.get_default_group()

Get default group of users.

Returns:

components.group.api.get_group_by_id(group_id)

Return a group given its primary key.

Parameters:group_id (str) – Given group id
Returns:Group object
components.group.api.get_or_create(name)

Get or create a group. :param name:

Returns: