Citrix ADM NITRO API Reference

rba_authscope_props

Configuration for RBA Authorized Scope Properties resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
propname <String> Read-write Prop Name.
rbaoperator <String> Read-write RBA operator has to be given as true if regex has been given for individual entities for services,servicegroup,servers while creating or modifying group..
id <String> Read-write Id is system generated key for all the auth scope properties.
propvalue <String> Read-write comma separated ids or use ALL for everything.
parent_name <String> Read-only .
parent_id <String> Read-only .
propvalues <String[]> Read-only Values for a Propname.

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_authscope_props