Update the list of administrators on a tenant

Hybrid Data Pipeline API reference : Administrators API : Tenant API : Update the list of administrators on a tenant

Try Now

Purpose

Updates administrators for a tenant

URL

https://<myserver>:<port>/api/admin/tenants/{id}/admins

Method

PUT

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.

Request Payload Definition

The request payload is a JSON object defined as follows:

{
"admins": [
user_id,
user_id,
...
]
}

Property	Description	Valid Values
"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. Any administrator users listed must reside in the system tenant or the tenant that is being updated.

Sample Request Payload

{
"admins": [
45,
75,
105
]
}

Sample Server Success Response

Status code: 200
Successful response

{
"admins": [
45,
75,
105
]
}

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.