The Tenant API allows administrators to create, view, modify, and delete tenants. To use the Tenant API, a user must have either the Administrator (12) permission or the TenantAPI (25) permission. Any user with the Administrator permission is in effect a system administrator. System administrators can create tenants and can view, modify, and delete all tenants across the system. Users must have the TenantAPI permission to create tenants. Users must also have administrative access for a given tenant to be able to view, modify, and delete tenants. There are two ways users may obtain administrative access on specific tenants. First, users have administrative access on any tenant they create. Second, a user can be granted administrative access on a tenant when the tenant is created or by updating the list of administrators on a tenant.

The Tenant API can be used to perform the following operations.

Operation Request URL
Retrieve a list of tenants in the system GET https://<myserver>:<port>/api/admin/tenants
Create a new tenant POST https://<myserver>:<port>/api/admin/tenants
Retrieve information on a tenant GET https://<myserver>:<port>/api/admin/tenants/{id}
Update a tenant PUT https://<myserver>:<port>/api/admin/tenants/{id}
Delete a tenant DELETE https://<myserver>:<port>/api/admin/tenants/{id}
Retrieve the list of administrators for a tenant PUT https://<myserver>:<port>/api/admin/tenants/{id}/admins
Update the list of administrators for a tenant GET https://<myserver>:<port>/api/admin/tenants/{id}/admins