Citrix ADM NITRO API Reference

tenant_company_info

Configuration for Company Information of Tenant resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
department Read-write Department of the tenant.
company_name Read-write Name of the tenant company.
zip_code Read-write Zipcode of the tenant.
state Read-write State of the tenant.
last_name Read-write URL of the tenant.
parent_id Read-write .
city Read-write City of the tenant.
tenant_id Read-write Id of the parent tenant.
url Read-write URL of the tenant.
address Read-write URL of the tenant.
id Read-write .
email_address Read-write Email Address of the tenant.
country Read-write Country of the tenant.
parent_name Read-write .
phone_number Read-write Phone number of the tenant.
preferred_lang Read-write Preferred Language.
first_name Read-write First name of the tenant.

Operations

(click to see Properties )

    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

    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

    tenant_company_info