Citrix ADM NITRO API Reference

rba_submodule_client_data

Configuration for This resource is used to display the feature wise permissions tree during access policy creation in GUI. resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
id <String> Read-write Id is system generated key.
child_node <String> Read-only This is used if tree node is child node of another tree node in permission tree..
parent_name <String> Read-only Parent node name for UI tree node.
name <String> Read-only Unique name for tree node in UI.
ui_component <Boolean> Read-only This is used to mention if its UI component.
display_name <String> Read-only Display name for tree node in UI.
parent_id <String> Read-only Parent id for UI tree node.
serial_id <Integer> Read-only This is used to display the permissions tree in an order manner..
childmodules <rba_childmodule_client_data[]> Read-only This is used to display child nodes of particular feature in access policy tree..
operation <rba_operation_client_data[]> Read-only This is used to display operations of particular node in permissions tree..

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

    rba_submodule_client_data