Purpose

Updates a tenant

URL

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

Method

PUT

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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 Definition

{
    "name": "tenant_name",
    "description": "tenant_description",
    "parentTenant": parent_tenant_id,
    "status": tenant_status
}
Property Description Usage Valid Values
"name" The name of the tenant. Required A string that specifies the name of the tenant.
"description" A description of the tenant. Optional A string that provides a description of the tenant.
"parentTenant" The ID of the parent tenant. Optional 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. Required 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.

Sample Request Payload

{
    "name": "OrgB",
    "description": "This is a new description.",
    "parentTenant": 1,
    "status": 1
}

Sample Server Success Response 

   Status code: 200
   Successful response
{
    "id": 360,
    "name": "OrgB",
    "description": "This is a new description.",
    "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.