Product Documentation

authenticationvserver_authenticationlocalpolicy_binding

Sep 01, 2016

Binding object showing the authenticationlocalpolicy 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.
Minimum length = 1
nextfactor
<String>
Read-write
Applicable only while binding advance authentication policy as classic authentication policy does not support nFactor.
gotopriorityexpression
<String>
Read-write
Applicable only to advance authentication policy. Expression or other value specifying the next policy to be evaluated if the current policy evaluates to TRUE. Specify one of the following values: * NEXT - Evaluate the policy with the next higher priority number. * END - End policy evaluation. * USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT. * A default syntax expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows: * If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next. * If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next. * If the expression evaluates to a priority number that is numerically higher than the highest numbered priority, policy evaluation ends. An UNDEF event is triggered if: * The expression is invalid. * The expression evaluates to a priority number that is numerically lower than the current policy's priority. * The expression evaluates to a priority number that is between the current policy's priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
secondary
<Boolean>
Read-write
Bind the authentication policy to the secondary chain. Provides for multifactor authentication in which a user must authenticate via both a primary authentication method and, afterward, via a secondary authentication method. Because user groups are aggregated across authentication systems, usernames must be the same on all authentication servers. Passwords can be different.
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)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add:

URL: http://<netscaler-ip-address/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{
"authenticationvserver_authenticationlocalpolicy_binding":{
      "name":<String_value>,
      "policy":<String_value>,
      "priority":<Double_value>,
      "secondary":<Boolean_value>,
      "groupextraction":<Boolean_value>,
      "nextfactor":<String_value>,
      "gotopriorityexpression":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete:

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding/name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding/name_value<String>

Query-parameters:

filter

http://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding/name_value<String>?pagesize=#no&pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationvserver_authenticationlocalpolicy_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>
}]}

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationvserver_authenticationlocalpolicy_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://<netscaler-ip-address>/nitro/v1/config/authenticationvserver_authenticationlocalpolicy_binding/name_value<String>?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{"authenticationvserver_authenticationlocalpolicy_binding": [ { "__count": "#no"} ] }