Groups

class Groups(session_kwargs, client, return_type='raw')

Civis API /groups endpoint.

Methods

delete_members(id, user_id)	Remove a user from a group
delete_shares_groups(id, group_id)	Revoke the permissions a group has on this object
delete_shares_users(id, user_id)	Revoke the permissions a user has on this object
get(id)	Get a Group
get_child_groups(id)	Get child groups of this group
list(*[, query, permission, ...])	List Groups
list_child_groups(id)	Get child groups of this group
list_shares(id)	List users and groups permissioned on this object
patch(id, *[, name, description, slug, ...])	Update some attributes of this Group
post(name, *[, description, slug, ...])	Create a Group
put(id, name, *[, description, slug, ...])	Replace all attributes of this Group
put_members(id, user_id)	Add a user to a group
put_shares_groups(id, group_ids, ...[, ...])	Set the permissions groups has on this object
put_shares_users(id, user_ids, ...[, ...])	Set the permissions users have on this object