The tenant API uses the GET method to obtain the list of tenants from the Presentation Server. The permissions granted for the administrator who makes the request determines which tenants appear in the JSON response. For example, an administrator for the Acme account could not see the tenants in the Calbro account.
TSWS APIs that use the POST method
| API | Description |
|---|---|
| login | Obtains the authToken required to perform all other operations |
| configdata | Retrieves configuration data of monitor instances |
| perfdata | Retrieves performance data of monitor instances |
TSWS APIs that use the GET method
| API | Description |
|---|---|
| devices | Retrieves a list of monitored devices |
| instances | Retrieves a list of monitored instances |
| monitortypes | Retrieves a list of monitor types |
| tenants | Retrieves a list of tenants |
Before you begin
You must have used the login API to obtain the authToken, which authenticates the user performing the operation. For details, see TSWS authentication.
Request syntax
GET https://<PresentationServerHostName>/tsws/10.0/api/omprovider/tenants
Request parameters
| Element | Description |
|---|---|
| authToken | Value of the authToken generated through the login API |
Sample request with REST client
- Enter the URL for the tenant list API. The generic format is:
https://<PresentationServerHostName>/tsws/10.0/api/omprovider/tenants - Add a new header.
- Select Authorization as the header type.
- Enter the text authToken followed by the authToken generated through the login API. See TSWS authentication.
- Click Send.
JSON response content
The tenant API request returns the following tenant information in the JSON response:
| Object | Description |
|---|---|
| tenantList | List of tenants that the authorized user can access |
| tenantId | Tenant name |
Sample JSON response
