skip to main content
Hybrid Data Pipeline API reference : Administrators API : Tenant API : Get information on a tenant
  

Try Now
Get information on a tenant

Purpose

Returns information for a tenant

URL

https://<myserver>:<port>/api/admin/tenants/{id}
Additional information, including tenant roles and administrators, can be retrieved by setting the details query parameter to true (?details=true).
https://<myserver>:<port>/api/admin/tenants/{id}?details=true

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.
The URL parameter {id} described in the following table is required.
Parameter
Description
Valid Values
{id}
The ID of the tenant.
A valid tenant ID.

Response Definition

The response takes the following format. The parameters of the response are described in the table that follows.
Note: The roles and admins properties are provided when the query ?details=true has been added to the URL.
{
"id": tenant_id,
"name": "tenant_name",
"description": "tenant_description",
"parentTenant": parent_tenant_id,
"status": tenant_status,
"roles": [
role_id,
role_id,
...
],
"admins": [
user_id,
user_id,
...
]
}
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.
"description"
A description of the tenant.
A string that provides a description of the tenant.
"parentTenant"
The ID of the parent tenant.
null | 1
null is returned when the query is executed for the system tenant.
1 is returned when the query is executed for tenants in the system tenant.
"status"
The status of the tenant.
This option will be available with a future update.
0 | 1
0 specifies that the tenant is inactive.
1 specifies that the tenant is active.
"roles"
The role or roles that belong to the tenant.
A valid role ID or comma-separated list of valid role IDs.
"admins"
A list of administrators who have administrative access to the tenant.
A valid user ID or comma-separated list of valid user IDs.
Any user that appears in this list has administrative access on the tenant. However, the user must have permissions to execute corresponding operations.

Sample Server Success Response


Status code: 200
Successful response
{
"id": 360,
"name": "OrgB",
"description": "This is the HDP tenant for organization B.",
"parentTenant": 1,
"status": 1
}

Sample Server Failure Response

{
"error": {
"code": 222208573,
"message": {
"lang": "en-US",
"value": "There is no Tenant with that id: 22."
}
}
}

Authentication

Basic Authentication using Login ID and Password

Authorization

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