Package comodit_client :: Package api :: Module organization :: Class Organization

Class Organization

An organization's representation. An organization contains a list of environments, applications, platforms and distributions. The hosts defined in organization's environments can only use platforms, distributions and applications from this organization. Note that applications and distributions of an organization may have been purchased from store. Several ComodIT users can share the same organization, access control is configured by adding/removing users from organization's groups. An organization may have settings, these settings being available to all hosts in its environment.

An organization owns the following collections:

settings (settings())
environments (environments())
applications (applications())
distributions (distributions())
platforms (platforms())
audit logs (audit_logs())
groups (groups())
purchased applications (purchased_apps())
purchased distributions (purchased_dists())

Instance Methods

ApplicationCollection

applications(self)
Instantiates the collection of applications associated to this organization.

Application

get_application(self, name)
Fetches an application of this organization given its name.

ApplicationCollection

platforms(self)
Instantiates the collection of applications associated to this organization.

Application

get_platform(self, name)
Fetches an application of this organization given its name.

DistributionCollection

distributions(self)
Instantiates the collection of distributions associated to this organization.

Distribution

get_distribution(self, name)
Fetches a distribution of this organization given its name.

EnvironmentCollection

environments(self)
Instantiates the collection of environments associated to this organization.

Environment

get_environment(self, name)
Fetches an environment of this organization given its name.

GroupCollection

groups(self)
Instantiates the collection of groups associated to this organization.

Group

get_group(self, name)
Fetches a group of this organization given its name.

reset_secret(self)
Resets the secret key of this organization.

AuditLogCollection

audit_logs(self)
Instantiates the collection of audit logs associated to this organization.

PurchasedCollection

purchased_apps(self)
Instantiates the collection of purchased applications associated to this organization.

PurchasedEntity

get_purchased_app(self, uuid)
Fetches a purchased application.

PurchasedCollection

purchased_dists(self)
Instantiates the collection of purchased distributions associated to this organization.

PurchasedEntity

get_purchased_dist(self, uuid)
Fetches a purchased distribution.

ApplicationKeyCollection

application_keys(self)
Instantiates the collection of application keys associated to this organization.

Inherited from settings.HasSettings: add_link_setting, add_property_setting, add_setting, add_simple_setting, get_setting, settings

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
list of string	environment_names The name of organization's environments.
list of string	group_names The name of organization's groups.
string	access_key The access key of this organization.
string	secret_key The secret key of this organization.
Inherited from `settings.HasSettings`: `settings_f` Inherited from `entity.Entity`: `client`, `description`, `identifier`, `label`, `name`, `url`, `uuid` Inherited from `object`: `__class__`

Method Details

applications(self)

Instantiates the collection of applications associated to this organization.

Returns: ApplicationCollection: The collection of applications associated to this organization.

get_application(self, name)

Fetches an application of this organization given its name.

Parameters:

name (string) - The name of the application.

Returns: Application

platforms(self)

Instantiates the collection of applications associated to this organization.

Returns: ApplicationCollection: The collection of applications associated to this organization.

get_platform(self, name)

Fetches an application of this organization given its name.

Parameters:

name (string) - The name of the application.

Returns: Application

distributions(self)

Instantiates the collection of distributions associated to this organization.

Returns: DistributionCollection: The collection of distributions associated to this organization.

get_distribution(self, name)

Fetches a distribution of this organization given its name.

Parameters:

name (string) - The name of the distribution.

Returns: Distribution

environments(self)

Instantiates the collection of environments associated to this organization.

Returns: EnvironmentCollection: The collection of environments associated to this organization.

get_environment(self, name)

Fetches an environment of this organization given its name.

Parameters:

name (string) - The name of the environment.

Returns: Environment

groups(self)

Instantiates the collection of groups associated to this organization.

Returns: GroupCollection: The collection of groups associated to this organization.

get_group(self, name)

Fetches a group of this organization given its name.

Parameters:

name (string) - The name of the group.

Returns: Group

audit_logs(self)

Instantiates the collection of audit logs associated to this organization.

Returns: AuditLogCollection: The collection of audit logs associated to this organization.

purchased_apps(self)

Instantiates the collection of purchased applications associated to this organization.

Returns: PurchasedCollection: The collection of purchased applications associated to this organization.

get_purchased_app(self, uuid)

Fetches a purchased application.

Parameters:

uuid (string) - The UUID of the purchased application.

Returns: PurchasedEntity

purchased_dists(self)

Instantiates the collection of purchased distributions associated to this organization.

Returns: PurchasedCollection: The collection of purchased distributions associated to this organization.

get_purchased_dist(self, uuid)

Fetches a purchased distribution.

Parameters:

uuid (string) - The UUID of the purchased distribution.

Returns: PurchasedEntity

application_keys(self)

Instantiates the collection of application keys associated to this organization.

Returns: ApplicationKeyCollection: The collection of application keys associated to this organization.

Property Details

environment_names

The name of organization's environments.

Get Method:: unreachable.environment_names(self) - The name of organization's environments.
Type:: list of string

group_names

The name of organization's groups.

Get Method:: unreachable.group_names(self) - The name of organization's groups.
Type:: list of string

access_key

The access key of this organization.

Get Method:: unreachable.access_key(self) - The access key of this organization.
Type:: string

secret_key

The secret key of this organization.

Get Method:: unreachable.secret_key(self) - The secret key of this organization.
Type:: string