skip to main content
Hybrid Data Pipeline API reference : Administrators API : Tenant API
  

Try Now

Tenant API

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
GET
https://<myserver>:<port>/api/admin/tenants
POST
https://<myserver>:<port>/api/admin/tenants
GET
https://<myserver>:<port>/api/admin/tenants/{id}
PUT
https://<myserver>:<port>/api/admin/tenants/{id}
DELETE
https://<myserver>:<port>/api/admin/tenants/{id}
PUT
https://<myserver>:<port>/api/admin/tenants/{id}/admins
GET
https://<myserver>:<port>/api/admin/tenants/{id}/admins
* Get tenants
* Create a tenant
* Get information on a tenant
* Update a tenant
* Delete a tenant
* Get the list of administrators for a tenant
* Update the list of administrators on a tenant