Skip to content

tenant

Configuration for Tenants resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
service_type<Double>Read-writeType of service, Setting the bits for MAS, NGS, WAF.
dbrole_name<String>Read-writeDatabase Role Name for tenant.
Minimum length = 1
Maximum length = 128
system_resource<tenant_system_resource>Read-writeTenant System Resource.
name<String>Read-writeName of the Tenant.
Minimum length = 1
Maximum length = 512
schema_name<String>Read-writeSchema Name for tenant.
Minimum length = 1
Maximum length = 128
company_info<tenant_company_info>Read-writeTenant Company Information.
user_name<String>Read-writeUser Name for tenant.
Minimum length = 1
Maximum length = 128
parent_id<String>Read-writeTenant ID of the parent Tenant..
access_to_parent<Boolean>Read-writeEnable Shell access for non-nsroot User(s).
password<String>Read-writePassword.
Minimum length = 1
Maximum length = 128
preauthtoken<String>Read-writePreauth token for a tenant.
Minimum length = 1
Maximum length = 512
id<String>Read-writeId is system generated key for all the Tenants.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: https://<MGMT-IP>/nitro/v1/config/tenant?onerror=<String_value>

HTTP Method: null

Request Payload:

{tenant: {
<b>"user_name":<String_value></b>,
<b>"parent_id":<String_value></b>,
<b>"password":<String_value></b>,
"dbrole_name":<String_value>,
"service_type":<Double_value>,
"system_resource":<tenant_system_resource_value>,
"name":<String_value>,
"schema_name":<String_value>,
"company_info":<tenant_company_info_value>,
"access_to_parent":<Boolean_value>,
"preauthtoken":<String_value>,
"id":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tenant":[{
"service_type":<Double_value>,
"dbrole_name":<String_value>,
"system_resource":<tenant_system_resource_value>,
"name":<String_value>,
"schema_name":<String_value>,
"company_info":<tenant_company_info_value>,
"user_name":<String_value>,
"parent_id":<String_value>,
"access_to_parent":<Boolean_value>,
"password":<String_value>,
"preauthtoken":<String_value>,
"id":<String_value>,
"admin_tenant":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/tenant/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/tenant

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tenant":[{
"service_type":<Double_value>,
"dbrole_name":<String_value>,
"system_resource":<tenant_system_resource_value>,
"name":<String_value>,
"schema_name":<String_value>,
"company_info":<tenant_company_info_value>,
"user_name":<String_value>,
"parent_id":<String_value>,
"access_to_parent":<Boolean_value>,
"password":<String_value>,
"preauthtoken":<String_value>,
"id":<String_value>,
"admin_tenant":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/tenant/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tenant":[{
"service_type":<Double_value>,
"dbrole_name":<String_value>,
"system_resource":<tenant_system_resource_value>,
"name":<String_value>,
"schema_name":<String_value>,
"company_info":<tenant_company_info_value>,
"user_name":<String_value>,
"parent_id":<String_value>,
"access_to_parent":<Boolean_value>,
"password":<String_value>,
"preauthtoken":<String_value>,
"id":<String_value>,
"admin_tenant":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/tenant/id_value<String>

HTTP Method: null

Request Payload:

{tenant:{
<b>"id":<String_value></b>,
"dbrole_name":<String_value>,
"service_type":<Double_value>,
"system_resource":<tenant_system_resource_value>,
"name":<String_value>,
"schema_name":<String_value>,
"company_info":<tenant_company_info_value>,
"parent_id":<String_value>,
"user_name":<String_value>,
"password":<String_value>,
"access_to_parent":<Boolean_value>,
"preauthtoken":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "tenant":[{
"service_type":<Double_value>,
"dbrole_name":<String_value>,
"system_resource":<tenant_system_resource_value>,
"name":<String_value>,
"schema_name":<String_value>,
"company_info":<tenant_company_info_value>,
"user_name":<String_value>,
"parent_id":<String_value>,
"access_to_parent":<Boolean_value>,
"password":<String_value>,
"preauthtoken":<String_value>,
"id":<String_value>,
"admin_tenant":<String_value>}]}