<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 user account
The ID is auto-generated when the user account is created and cannot be changed.
Request Payload Definition
The request takes the following format. The properties of the request are described in the table that follows.
The ID or IDs of the tenants that the user administers.
A valid tenant ID or comma-separated list of valid tenant IDs.
Sample Payload Request
{
"tenantsAdministered": [
27,
32,
37
]
}
Sample Server Response
Status code: 200
Successful response
{
"tenantsAdministered": [
27,
32,
37
]
}
Sample Server Failure Response
{
"error":{
"code":222207916,
"message":{
"lang":"en-US",
"value":"There is no User with that id: 123."
}
}
}
Authentication
Basic Authentication using Login ID and Password
Authorization
The user must have the Administrator (12) permission; or the user must have the TenantAPI (25) permission, ModifyUsers (15) permission, and administrative access on the tenant.
