tenant

Configuration for Tenants resource.

Read/write properties

light_tenant<Double>

Type of tenant schema, Setting the bits for full tenant with all tables.

parent_id<String>

Tenant ID of the parent Tenant..

password<String>

Password.
Minimum length = 1
Maximum length = 128

schema_name<String>

Schema Name for tenant.
Minimum length = 1
Maximum length = 128

user_name<String>

User Name for tenant.
Minimum length = 1
Maximum length = 128

name<String>

Name of the Tenant.
Minimum length = 1
Maximum length = 512

is_pool_lic_user<Boolean>

Check if the customer is a pooled/ flexed licensing user.

dbrole_name<String>

Database Role Name for tenant.
Minimum length = 1
Maximum length = 128

id<String>

Id is system generated key for all the Tenants.

preauthtoken<String>

Preauth token for a tenant.
Minimum length = 1
Maximum length = 512

company_info<tenant_company_info>

Tenant Company Information.

tenant_user_name<String>

User Name for tenant.
Maximum length = 128

service_type<Double>

Type of service, Setting the bits for NetScaler Console, NGS, WAF.

access_to_parent<Boolean>

Enable Shell access for non-nsroot User(s).

system_resource<tenant_system_resource>

Tenant System Resource.

act_id<String>

Activity ID that is used by GUI to track the provisioning status..

entitlement<String>

Entitlement string received from citrix cloud..

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add

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

HTTPS Method:POST

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"tenant": {
      "parent_id":<String_value>,
      "password":<String_value>,
      "user_name":<String_value>,
      "tenant_user_name":<String_value>,
      "id":<String_value>,
      "act_id":<String_value>,
      "preauthtoken":<String_value>,
      "access_to_parent":<Boolean_value>,
      "entitlement":<String_value>,
      "system_resource":<tenant_system_resource_value>,
      "company_info":<tenant_company_info_value>,
      "service_type":<Double_value>,
      "light_tenant":<Double_value>,
      "name":<String_value>,
      "is_pool_lic_user":<Boolean_value>,
      "dbrole_name":<String_value>,
      "schema_name":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{
      "light_tenant":<Double_value>,
      "parent_id":<String_value>,
      "database_name":<String_value>,
      "password":<String_value>,
      "schema_name":<String_value>,
      "user_name":<String_value>,
      "name":<String_value>,
      "is_pool_lic_user":<Boolean_value>,
      "admin_tenant":<String_value>,
      "dbrole_name":<String_value>,
      "id":<String_value>,
      "preauthtoken":<String_value>,
      "company_info":<tenant_company_info_value>,
      "cc_region":<String_value>,
      "is_tenant_post_54x":<Boolean_value>,
      "tenant_user_name":<String_value>,
      "service_type":<Double_value>,
      "access_to_parent":<Boolean_value>,
      "system_resource":<tenant_system_resource_value>,
      "act_id":<String_value>,
      "entitlement":<String_value>}]}

update

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

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"tenant":{
      "id":<String_value>,
      "access_to_parent":<Boolean_value>,
      "entitlement":<String_value>,
      "system_resource":<tenant_system_resource_value>,
      "company_info":<tenant_company_info_value>,
      "tenant_user_name":<String_value>,
      "service_type":<Double_value>,
      "act_id":<String_value>,
      "preauthtoken":<String_value>,
      "is_pool_lic_user":<Boolean_value>,
      "name":<String_value>,
      "dbrole_name":<String_value>,
      "schema_name":<String_value>,
      "user_name":<String_value>,
      "password":<String_value>,
      "light_tenant":<Double_value>,
      "parent_id":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{
      "light_tenant":<Double_value>,
      "parent_id":<String_value>,
      "database_name":<String_value>,
      "password":<String_value>,
      "schema_name":<String_value>,
      "user_name":<String_value>,
      "name":<String_value>,
      "is_pool_lic_user":<Boolean_value>,
      "admin_tenant":<String_value>,
      "dbrole_name":<String_value>,
      "id":<String_value>,
      "preauthtoken":<String_value>,
      "company_info":<tenant_company_info_value>,
      "cc_region":<String_value>,
      "is_tenant_post_54x":<Boolean_value>,
      "tenant_user_name":<String_value>,
      "service_type":<Double_value>,
      "access_to_parent":<Boolean_value>,
      "system_resource":<tenant_system_resource_value>,
      "act_id":<String_value>,
      "entitlement":<String_value>}]}

get (all)

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

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/tenant?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of tenant resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/tenant?pagesize=#no&pageno=#no

Use this query-parameter to get the tenant resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/tenant?count=yes

Use this query-parameter to get the count of tenant resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{
      "light_tenant":<Double_value>,
      "parent_id":<String_value>,
      "database_name":<String_value>,
      "password":<String_value>,
      "schema_name":<String_value>,
      "user_name":<String_value>,
      "name":<String_value>,
      "is_pool_lic_user":<Boolean_value>,
      "admin_tenant":<String_value>,
      "dbrole_name":<String_value>,
      "id":<String_value>,
      "preauthtoken":<String_value>,
      "company_info":<tenant_company_info_value>,
      "cc_region":<String_value>,
      "is_tenant_post_54x":<Boolean_value>,
      "tenant_user_name":<String_value>,
      "service_type":<Double_value>,
      "access_to_parent":<Boolean_value>,
      "system_resource":<tenant_system_resource_value>,
      "act_id":<String_value>,
      "entitlement":<String_value>}]}

get

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{
      "light_tenant":<Double_value>,
      "parent_id":<String_value>,
      "database_name":<String_value>,
      "password":<String_value>,
      "schema_name":<String_value>,
      "user_name":<String_value>,
      "name":<String_value>,
      "is_pool_lic_user":<Boolean_value>,
      "admin_tenant":<String_value>,
      "dbrole_name":<String_value>,
      "id":<String_value>,
      "preauthtoken":<String_value>,
      "company_info":<tenant_company_info_value>,
      "cc_region":<String_value>,
      "is_tenant_post_54x":<Boolean_value>,
      "tenant_user_name":<String_value>,
      "service_type":<Double_value>,
      "access_to_parent":<Boolean_value>,
      "system_resource":<tenant_system_resource_value>,
      "act_id":<String_value>,
      "entitlement":<String_value>}]}

delete

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

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }