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

Try Now
Get tenants

Purpose

Returns a list of all tenants

URL

https://<myserver>:<port>/api/admin/tenants

Method

GET

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Response Definition

The response takes the following format. The parameters of the response are described in the table that follows.
{
"tenants": [
{
"id": tenant_id,
"name": "tenant_name"
},
...
]
}
Property
Description
Valid Values
"id"
The ID of the tenant.
A valid tenant ID.
"name"
The name of the tenant.
A string that specifies the name of the tenant.

Sample Server Success Response


Status code: 200
Successful response
{
"tenants": [
{
"id": 1,
"name": "System"
},
{
"id": 71,
"name": "OrgA"
},
{
"id": 72,
"name": "OrgB"
},
{
"id": 73,
"name": "OrgB"
}
]
}

Sample Server Failure Response

{
"error":{
"code": 222208103,
"message":{
"lang":"en-US",
"value":"You lack the permissions to access this url."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) or the TenantAPI (25) permission.