Organisation¶

class Organisation(parent=None)¶

Bases: Item

This class describes an Organisation object child of Item class.

add_member(user_key)¶

Add an existing user in your organisation

Parameters:: user_key (string) – The user key of the user to add in the organisation
Returns:: User object
Return type:: User

create_member(email, name=None, aquarium_url=None)¶

Create a new member in your organisation

Parameters:

email (string) – The email of the new member
name (string, optional) – The name of the new member
aquarium_url (string, optional (default is api_url used during module initialisation)) – The Aquarium Studio interface url. Useful if API url is not the same as Aquarium Studio interface.

Returns:

User object

Return type:

User

get_active_members(limit=200, offset=None)¶

Gets all active members of the organisation

Parameters:

limit (integer) – Maximum limit number of returned members
offset (integer) – Number of skipped members. Used for pagination

Returns:

List of User object

Return type:

List of User

get_all_members(limit=200, offset=None)¶

Gets all members of the organisation

Parameters:

limit (integer) – Maximum limit number of returned members
offset (integer) – Number of skipped members. Used for pagination

Returns:

List of User object

Return type:

List of User

get_inactive_members(limit=200, offset=None)¶

Gets all inactive members of the organisation

Parameters:

limit (integer) – Maximum limit number of returned members
offset (integer) – Number of skipped members. Used for pagination

Returns:

List of User object

Return type:

List of User

get_member_by_email(email)¶

Get an exising member of the organisation by his/her email

Returns:: User object
Return type:: User

get_suborganisations(limit=200, offset=None)¶

Gets all suborganisations

Parameters:

limit (integer) – Maximum limit number of returned organisations
offset (integer) – Number of skipped organisations. Used for pagination

Returns:

List of Organisation object

Return type:

List of Organisation