Organization module

Organization is the representation of a group of users on the Platform. Every user must be part of at least one organization.

Each Organization has:

  • Auto-generated unique organization ID.

  • An organization name, which you provide.

  • miscellaneous metadata: e.g., creator name, timestamp, etc.

  • You may add multiple users to the same organization.

Client Module

class Client(auth_token, project=None)

Client class provides access to device, package, volume and deployment classes.

__init__(auth_token, project=None)

Get new client object

Parameters

  • auth_token (string) – Authentication token

  • project (string) – project_guid of the user

Organization Module

class Country

Country is the representation of country details of an Organization on the platform.

Variables

  • id (int) – id of the Country

  • created_at (str) – creation time of the Country details on the platform

  • updated_at (str) – updation time of the Country details on the platform

  • deleted_at (str) – deletion time of the Country details on the platform

  • name (str) – name of the Country

  • code (str) – code of the Country

class Organization

Organization is the representation of a group of users on the Platform. Every user must be part of at least one organization.

Variables

  • guid (str) – guid of the Organization

  • name (str) – Name of the Organization

  • country_id (int) – County ID of the Organization

  • country (Country) – Country details of the Organization

  • province (str) – Province of the Organization

  • postal_code (str) – Postal Code of the Organization

  • url (str) – URL of the Organization

  • plan_id (int) – Plan ID of the Organization

  • state (OrganizationState) – The state of the Organization on the Platform

  • creator (str) – GUID of the User that created the Organization

  • short_guid (str) – short guid of the Organization

class OrganizationState(value)

Enumeration variables for OrganizationState.

OrganizationState can be any of the following types

OrganizationState.ACTIVATED (‘ACTIVATED’)

OrganizationState.SUSPENDED (‘SUSPENDED’)

OrganizationState.MARKEDSUSPENSION (‘MARKEDSUSPENSION’)