Tenants Web Service

The API provides the tenants web service to let you view, create, and modify tenant definitions.
Local admin users can view, create, and modify tenant definitions using the
web service. The basic tenant definition contains a few parameters to identify the tenant. The infrastructure—devices, networks, servers—and the monitoring parameters for a customer's monitored systems must be associated with the tenant definition. Each tenant must contain at least one IP domain, plus as many of the following definitions as required to manage the associated enterprise infrastructure and applications:
  • User accounts
  • Roles
  • Custom and system groups
  • Custom reports
  • Custom menus
To associate definitions and monitoring parameters with an existing tenant definition, log in as the tenant administrator and create the required definitions using the required web services. The definitions are then associated with the tenant definition and available to users logged in with this tenant's user accounts.
For more information about how to create a tenant using the
web service, see Automate Provisioning and Configuration using the tenants Web Service.
In this article:
Tenants Web Service Parameters
Issue the following call to see the available parameters and operations for the
web service:
  • tenantDescription
    (Optional) Describes the tenant.
  • idName
    Is a name for the tenant.
  • status
    Is the status of this tenant.
    • Activated:
      Enables tenant user accounts for use.
    • Disabled:
      Prevents any actions by user accounts that are associated with this tenant.
  • removable
    States whether the item can be deleted (removed from the database).
    : true or false
  • theme
    Specifies the format—the theme that controls the appearance of the page in the browser window—to use for this tenant. All operators whose user account is associated with this tenant see this same theme. The CA-Blue and CA-Gray are available.
  • defaultCulture
    Specifies a language (locale). Supply a language identifier from the following list:
    • en-US (English, United States)
    • ja-JP (Japanese)
    • zh-CN (Simplified Chinese)
    • fr-FR (French, France)
  • accountId
    Identifies this tenant; usually corresponds to the MSP account number. If a value is supplied as input, it must be unique across all defined tenants.
  • tenantID
    Is an internal (database) identifier for a tenant definition.
Tenants Web Service Example Syntax
You can retrieve a current list of tenant definitions, create tenant definitions, and modify these definitions by changing their parameters using the
web service.
You can use the following basic HTTP methods with the
web service:
  • GET
    Returns a list of tenant definitions sorted by name. Available on the /tenantID endpoint. Use the following syntax:
  • POST
    Creates a custom tenant. Use the following syntax:
    :8181/pc /center/webservice/tenants/
  • PUT
    Updates an existing tenant definition. Use the following syntax: