34 lines
22 KiB
HTML
34 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>tenant</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">tenant</p>
|
|
<P>Configuration for Tenants resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">light_tenant<span class="property_type"><Double></span></p><p class="property_description">Type of tenant schema, Setting the bits for full tenant with all tables.</p>
|
|
<p class="property_name">parent_id<span class="property_type"><String></span></p><p class="property_description">Tenant ID of the parent Tenant..</p>
|
|
<p class="property_name">password<span class="property_type"><String></span></p><p class="property_description">Password.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">schema_name<span class="property_type"><String></span></p><p class="property_description">Schema Name for tenant.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">user_name<span class="property_type"><String></span></p><p class="property_description">User Name for tenant.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of the Tenant.<br> Minimum length = 1<br> Maximum length = 512</p>
|
|
<p class="property_name">is_pool_lic_user<span class="property_type"><Boolean></span></p><p class="property_description">Check if the customer is a pooled/ flexed licensing user.</p>
|
|
<p class="property_name">dbrole_name<span class="property_type"><String></span></p><p class="property_description">Database Role Name for tenant.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the Tenants.</p>
|
|
<p class="property_name">preauthtoken<span class="property_type"><String></span></p><p class="property_description">Preauth token for a tenant.<br> Minimum length = 1<br> Maximum length = 512</p>
|
|
<p class="property_name">company_info<span class="property_type"><tenant_company_info></span></p><p class="property_description">Tenant Company Information.</p>
|
|
<p class="property_name">tenant_user_name<span class="property_type"><String></span></p><p class="property_description">User Name for tenant.<br> Maximum length = 128</p>
|
|
<p class="property_name">service_type<span class="property_type"><Double></span></p><p class="property_description">Type of service, Setting the bits for NetScaler Console, NGS, WAF.</p>
|
|
<p class="property_name">access_to_parent<span class="property_type"><Boolean></span></p><p class="property_description">Enable Shell access for non-nsroot User(s).</p>
|
|
<p class="property_name">system_resource<span class="property_type"><tenant_system_resource></span></p><p class="property_description">Tenant System Resource.</p>
|
|
<p class="property_name">act_id<span class="property_type"><String></span></p><p class="property_description">Activity ID that is used by GUI to track the provisioning status..</p>
|
|
<p class="property_name">entitlement<span class="property_type"><String></span></p><p class="property_description">Entitlement string received from citrix cloud..</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#add" class="operation">add</a><a href="#update" class="operation">update</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/tenant?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"tenant": {<br><font color=#FF0000><b> "parent_id":<String_value></b></font>,<br><font color=#FF0000><b> "password":<String_value></b></font>,<br><font color=#FF0000><b> "user_name":<String_value></b></font>,<br><font color=#FF0000><b> "tenant_user_name":<String_value></b></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "act_id":<String_value></font>,<br><font color=#000000> "preauthtoken":<String_value></font>,<br><font color=#000000> "access_to_parent":<Boolean_value></font>,<br><font color=#000000> "entitlement":<String_value></font>,<br><font color=#000000> "system_resource":<tenant_system_resource_value></font>,<br><font color=#000000> "company_info":<tenant_company_info_value></font>,<br><font color=#000000> "service_type":<Double_value></font>,<br><font color=#000000> "light_tenant":<Double_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "is_pool_lic_user":<Boolean_value></font>,<br><font color=#000000> "dbrole_name":<String_value></font>,<br><font color=#000000> "schema_name":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{<br> "light_tenant":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "database_name":<String_value></font>,<br> "password":<String_value></font>,<br> "schema_name":<String_value></font>,<br> "user_name":<String_value></font>,<br> "name":<String_value></font>,<br> "is_pool_lic_user":<Boolean_value></font>,<br> "admin_tenant":<String_value></font>,<br> "dbrole_name":<String_value></font>,<br> "id":<String_value></font>,<br> "preauthtoken":<String_value></font>,<br> "company_info":<tenant_company_info_value></font>,<br> "cc_region":<String_value></font>,<br> "is_tenant_post_54x":<Boolean_value></font>,<br> "tenant_user_name":<String_value></font>,<br> "service_type":<Double_value></font>,<br> "access_to_parent":<Boolean_value></font>,<br> "system_resource":<tenant_system_resource_value></font>,<br> "act_id":<String_value></font>,<br> "entitlement":<String_value></font>}]}</p><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/tenant/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"tenant":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "access_to_parent":<Boolean_value></font>,<br><font color=#000000> "entitlement":<String_value></font>,<br><font color=#000000> "system_resource":<tenant_system_resource_value></font>,<br><font color=#000000> "company_info":<tenant_company_info_value></font>,<br><font color=#000000> "tenant_user_name":<String_value></font>,<br><font color=#000000> "service_type":<Double_value></font>,<br><font color=#000000> "act_id":<String_value></font>,<br><font color=#000000> "preauthtoken":<String_value></font>,<br><font color=#000000> "is_pool_lic_user":<Boolean_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "dbrole_name":<String_value></font>,<br><font color=#000000> "schema_name":<String_value></font>,<br><font color=#000000> "user_name":<String_value></font>,<br><font color=#000000> "password":<String_value></font>,<br><font color=#000000> "light_tenant":<Double_value></font>,<br><font color=#000000> "parent_id":<String_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{<br> "light_tenant":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "database_name":<String_value></font>,<br> "password":<String_value></font>,<br> "schema_name":<String_value></font>,<br> "user_name":<String_value></font>,<br> "name":<String_value></font>,<br> "is_pool_lic_user":<Boolean_value></font>,<br> "admin_tenant":<String_value></font>,<br> "dbrole_name":<String_value></font>,<br> "id":<String_value></font>,<br> "preauthtoken":<String_value></font>,<br> "company_info":<tenant_company_info_value></font>,<br> "cc_region":<String_value></font>,<br> "is_tenant_post_54x":<Boolean_value></font>,<br> "tenant_user_name":<String_value></font>,<br> "service_type":<Double_value></font>,<br> "access_to_parent":<Boolean_value></font>,<br> "system_resource":<tenant_system_resource_value></font>,<br> "act_id":<String_value></font>,<br> "entitlement":<String_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/tenant</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/tenant<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">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.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/tenant<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the tenant resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/tenant<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of tenant resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{<br> "light_tenant":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "database_name":<String_value></font>,<br> "password":<String_value></font>,<br> "schema_name":<String_value></font>,<br> "user_name":<String_value></font>,<br> "name":<String_value></font>,<br> "is_pool_lic_user":<Boolean_value></font>,<br> "admin_tenant":<String_value></font>,<br> "dbrole_name":<String_value></font>,<br> "id":<String_value></font>,<br> "preauthtoken":<String_value></font>,<br> "company_info":<tenant_company_info_value></font>,<br> "cc_region":<String_value></font>,<br> "is_tenant_post_54x":<Boolean_value></font>,<br> "tenant_user_name":<String_value></font>,<br> "service_type":<Double_value></font>,<br> "access_to_parent":<Boolean_value></font>,<br> "system_resource":<tenant_system_resource_value></font>,<br> "act_id":<String_value></font>,<br> "entitlement":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/tenant/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tenant":[{<br> "light_tenant":<Double_value></font>,<br> "parent_id":<String_value></font>,<br> "database_name":<String_value></font>,<br> "password":<String_value></font>,<br> "schema_name":<String_value></font>,<br> "user_name":<String_value></font>,<br> "name":<String_value></font>,<br> "is_pool_lic_user":<Boolean_value></font>,<br> "admin_tenant":<String_value></font>,<br> "dbrole_name":<String_value></font>,<br> "id":<String_value></font>,<br> "preauthtoken":<String_value></font>,<br> "company_info":<tenant_company_info_value></font>,<br> "cc_region":<String_value></font>,<br> "is_tenant_post_54x":<Boolean_value></font>,<br> "tenant_user_name":<String_value></font>,<br> "service_type":<Double_value></font>,<br> "access_to_parent":<Boolean_value></font>,<br> "system_resource":<tenant_system_resource_value></font>,<br> "act_id":<String_value></font>,<br> "entitlement":<String_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/tenant/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p>
|
|
</body>
|
|
</html>
|