cterasdk.core.portals module

class cterasdk.core.portals.Portals(portal)

Bases: cterasdk.core.base_command.BaseCommand

Global Admin Portals APIs

add(name, display_name=None, billing_id=None, company=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

Return str:

A relative url path to the Team Portal

browse(tenant)

Browse a tenant

Parameters:tenant (str) – Name of the tenant to browse

browse_global_admin()

Browse the Global Admin

delete(name)

Delete an existing tenant

Parameters:name (str) – Name of the tenant to delete

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