Download full document:

authenticationvserver_authenticationpolicy_binding

Binding object showing the authenticationpolicy that can be bound to authenticationvserver.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
priority	<Double>	Read-write	The priority, if any, of the vpn vserver policy.
name	<String>	Read-write	Name of the authentication virtual server to which to bind the policy.<br>Minimum length = 1
nextfactor	<String>	Read-write	On success invoke label.
gotopriorityexpression	<String>	Read-write	Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
secondary	<Boolean>	Read-write	Applicable only while bindind classic authentication policy as advance authentication policy use nFactor.
policy	<String>	Read-write	The name of the policy, if any, bound to the authentication vserver.
groupextraction	<Boolean>	Read-write	Applicable only while bindind classic authentication policy as advance authentication policy use nFactor.
acttype	<Double>	Read-only	.
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

ADD: | DELETE: | GET | COUNT

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>.

add:

URL: http://NS_IP/nitro/v1/config

HTTP Method: PUT

Request Payload:

{
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
sessionid":"##sessionid","authenticationvserver_authenticationpolicy_binding":{
      "name":<String_value>,
      "policy":<String_value>,
                  "priority":<Double_value>,
                  "secondary":<Boolean_value>,
                  "groupextraction":<Boolean_value>,
                  "nextfactor":<String_value>,
                  "gotopriorityexpression":<String_value>,

}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete:

URL: http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get

URL: http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding/name_value<String>

Query-parameters:

filter

http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of authenticationvserver_authenticationpolicy_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding/name_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the authenticationvserver_authenticationpolicy_binding resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "authenticationvserver_authenticationpolicy_binding": [ {
      "priority":<Double_value>,
      "name":<String_value>,
      "nextfactor":<String_value>,
      "gotopriorityexpression":<String_value>,
      "secondary":<Boolean_value>,
      "policy":<String_value>,
      "groupextraction":<Boolean_value>,
      "acttype":<Double_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/authenticationvserver_authenticationpolicy_binding/name_value<String>?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",authenticationvserver_authenticationpolicy_binding: [ { "__count": "#no"} ] }