kepler.api.user_group module¶

The module contains the functionality for REST API calls related to user groups.

class kepler.api.user_group.AddUserGroupParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for the REST API call add_user_group.

description = The description of the user group.¶

member_id_list = The list of the user IDs of the group members.¶

name = The name of the user group.¶

class kepler.api.user_group.DeleteUserGroupParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for the REST API call delete_user_group.

group_id = The ID of the group to be deleted.¶

class kepler.api.user_group.EditUserGroupParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for the REST API call edit_user_group.

description = The description of the user group.¶

group_id = The ID of the user group to be edited.¶

group_owner_id = The user ID of the group's new owner.¶

name = The name of the user group.¶

class kepler.api.user_group.RemoveUserGroupMemberParams¶

Bases: kepler.api.api_util.ApiParamsBase

The parameter class for the REST API call remove_user_group_memeber.

group_id = The ID of the user group to be edited.¶

user_id = The ID of the user that should be removed from the group.¶

kepler.api.user_group.add_user_group(request)¶

The function implements the REST API call add_user_group.

kepler.api.user_group.delete_user_group(request)¶

The function implements the REST API call delete_user_group.

kepler.api.user_group.edit_user_group(request)¶

The function implements the REST API call edit_user_group.

kepler.api.user_group.get_user_groups(request)¶

The function implements the REST API call get_user_groups.

kepler.api.user_group.remove_user_group_member(request)¶

The function implements the REST API call remove_user_group_member.