rba_ui¶

Configuration for This gives the information about which all tree nodes in GUI are authorized and will be visible to a user after login. resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
name	<String>	Read-write	Unique name for UI tree node.
id	<String>	Read-write	Id is system generated key for all the permission statements.
display_name	<String>	Read-write	Display name for UI tree node.
access_type	<Boolean>	Read-write	true, if access is allowed.
parent_name	<String>	Read-only	Parent node name for UI tree node.
parent_id	<String>	Read-only	Parent id for UI tree node.

Operations¶

(click to see Properties )

GET (ALL)
GET

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

get (all)¶

URL: https://<MGMT-IP>/nitro/v2/config/rba_ui Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/rba_ui ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of rba_ui 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/rba_ui ?pagesize=#no;pageno=#no Use this query-parameter to get the rba_ui resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/rba_ui ?count=yes Use this query-parameter to get the count of rba_ui 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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "rba_ui":[{
"parent_name":<String_value>,
"name":<String_value>,
"id":<String_value>,
"display_name":<String_value>,
"access_type":<Boolean_value>,
"parent_id":<String_value>}]}

get¶

URL: https://<MGMT-IP>/nitro/v2/config/rba_ui/id_value<String> HTTPS Method: GET