wxc_sdk.licenses package¶
Licenses
An allowance for features and services that are provided to users on a Webex services subscription. Cisco and its partners manage the amount of licenses provided to administrators and users. This license resource can be accessed only by an admin.
- class wxc_sdk.licenses.SiteType(value=<no_arg>, names=None, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶
Bases:
str
,SafeEnum
Webex site type
- control_hub = 'Control Hub managed site'¶
the site is managed by Webex Control Hub
- linked = 'Linked site'¶
the site is a linked site
- site_admin = 'Site Admin managed site'¶
the site is managed by Site Administration
- class wxc_sdk.licenses.License(*, id: str, name: str, totalUnits: int, consumedUnits: int, subscriptionId: str | None = None, siteUrl: str | None = None, siteType: SiteType | None = None)[source]¶
Bases:
ApiModel
Webex license
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.
- license_id: str¶
A unique identifier for the license.
- name: str¶
Name of the licensed feature.
- total_units: int¶
Total number of license units allocated.
- consumed_units: int¶
Total number of license units consumed.
- subscription_id: str | None¶
The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub.
- site_url: str | None¶
The Webex Meetings site associated with this license.
- property webex_calling: bool¶
is this a Webex Calling license
- property webex_calling_professional: bool¶
- property webex_calling_basic: bool¶
- property webex_calling_workspaces: bool¶
- class wxc_sdk.licenses.LicensesApi(*, session: RestSession, base: str | None = None)[source]¶
Bases:
ApiChild
Licenses
An allowance for features and services that are provided to users on a Webex services subscription. Cisco and its partners manage the amount of licenses provided to administrators and users. This license resource can be accessed only by an admin.
- list(org_id: str | None = None) Generator[License, None, None] [source]¶
List all licenses for a given organization. If no org_id is specified, the default is the organization of the authenticated user.
Response properties that are not applicable to the license will not be present in the response.
- Parameters:
org_id (str) – List licenses for this organization.
- Returns:
yields
License
instances
- details(license_id) License [source]¶
Shows details for a license, by ID.
Response properties that are not applicable to the license will not be present in the response.
- Parameters:
license_id (str) – The unique identifier for the license.
- Returns:
license details
- Return type:
- base = 'licenses'¶
- session: RestSession¶
REST session