cterasdk.core.portals module#
- class cterasdk.core.portals.Portals(core)#
Bases:
BaseCommand
Global Admin Portals APIs
- add(name, display_name=None, billing_id=None, company=None, plan=None, comment=None)#
Add a new tenant
- Parameters:
name (str) – Name of the new tenant
display_name (str,optional) – Display Name of the new tenant, defaults to None
billing_id (str,optional) – Billing ID of the new tenant, defaults to None
company (str,optional) – Company Name of the new tenant, defaults to None
plan (str,optional) – Subscription plan name to assign to the new tenant, defaults to None
comment (str,optional) – Assign a comment to the new tenant, defaults to None
- Return str:
A relative url path to the Team Portal
- apply_changes(wait=False)#
Apply provisioning changes.
- Parameters:
wait (bool,optional) – Wait for all changes to apply
- browse(tenant)#
Browse a tenant
- Parameters:
tenant (str) – Name of the tenant to browse
- browse_global_admin()#
Browse the Global Admin
- default = ['name']#
- delete(name)#
Delete an existing tenant
- Parameters:
name (str) – Name of the tenant to delete
- get(name, include=None)#
Get a tenant
- Parameters:
name (str) – Name of the tenant
include (list[str]) – List of fields to retrieve, defaults to [‘name’]
- list_tenants(include=None, portal_type=None)#
List tenants.
To retrieve tenants, you must first browse the Global Administration Portal, using: GlobalAdmin.portals.browse_global_admin()
- Parameters:
include (list[str],optional) – List of fields to retrieve, defaults to [‘name’]
portal_type (cterasdk.core.enum.PortalType) – The Portal type
- subscribe(tenant, plan)#
Subscribe a tenant to a plan
- Parameters:
name (str) – Name of the tenant
str,plan – Name of the subscription plan
- tenants(include_deleted=False)#
Get all tenants
- Parameters:
include_deleted (bool,optional) – Include deleted tenants, defaults to False
- undelete(name)#
Undelete a previously deleted tenant
- Parameters:
name (str) – Name of the tenant to undelete