Package comodit_client :: Package api :: Module organization :: Class Group

Class Group

The representation of an organization's group. A group is defined by a list of ComodIT users.

Instance Methods

add_user(self, username)
Adds a new user to this group.

remove_user(self, username)
Removes given user from list.

clear_users(self)
Remove all users from this group.

Inherited from entity.Entity: __init__, create, delete, dump, load, refresh, rename, show, update

Inherited from util.json_wrapper.JsonWrapper: dump_json, get_json, get_real_json, load_json, print_json, set_json

Inherited from object: __long__, __native__, __nonzero__, __unicode__, next

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
string	organization The name of the organization this group is part of.
list of User	users The users in this group.
Inherited from `entity.Entity`: `client`, `description`, `identifier`, `label`, `name`, `url`, `uuid` Inherited from `object`: `__class__`

Method Details

add_user(self, username)

Adds a new user to this group. In order to add a user to the group, at least its username must be set.

Parameters:

username (string) - The new user's username.

remove_user(self, username)

Removes given user from list.

Parameters:

username (string) - The username of the user to remove.

Property Details

organization

The name of the organization this group is part of.

Get Method:: unreachable.organization(self) - The name of the organization this group is part of.
Type:: string

users

The users in this group.

Get Method:: unreachable.users(self) - The users in this group.
Type:: list of User