wxc_sdk.organizations package

Organizations A set of people in Webex. Organizations may manage other organizations or be managed themselves. This organizations resource can be accessed only by an admin.

Applications can delete an Organization only after they have been authorized by a user with the Full Administrator Role which may be a user in the customer org or a user in a managing partner organization to which the role has been granted. The authorizing admin must grant the spark-admin:organizations-write scope.

class wxc_sdk.organizations.Organization(*, id: str, displayName: str, created: datetime)

Bases: ApiModel

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

org_id: str

A unique identifier for the organization.

display_name: str

Full name of the organization.

created: datetime

The date and time the organization was created.

class wxc_sdk.organizations.OrganizationApi(*, session: RestSession, base: Optional[str] = None)

Bases: ApiChild

list() → list[wxc_sdk.organizations.Organization]

List all organizations visible by your account. The results will not be paginated.

Returns

list of Organizations

details(org_id: str) → Organization

Get Organization Details

Shows details for an organization, by ID.

Parameters

org_id (str) – The unique identifier for the organization.

Returns

org details

Return type

Organization

delete(org_id: str)

Delete Organization

Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned.

Parameters

org_id (str) – The unique identifier for the organization.

base = 'organizations'

session: RestSession

REST session