Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

vpnvserver_authenticationoauthidppolicy_binding

August 17, 2023
Contributed by: 
C

Binding object showing the authenticationoauthidppolicy that can be bound to vpnvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
priority Read-write Integer specifying the policy’s priority. The lower the number, the higher the priority. Policies are evaluated in the order of their priority numbers. Maximum value for default syntax policies is 2147483647 and for classic policies is 64000.

Minimum value = 0

Maximum value = 2147483647
gotopriorityexpression Read-write Next priority expression.
policy Read-write The name of the policy, if any, bound to the VPN virtual server.
groupextraction Read-write Binds the authentication policy to a tertiary chain which will be used only for group extraction. The user will not authenticate against this server, and this will only be called if primary and/or secondary authentication has succeeded.
name Read-write Name of the virtual server.

Minimum length = 1
secondary Read-write Binds the authentication policy as the secondary policy to use in a two-factor configuration. A user must then authenticate not only via a primary authentication method but also via a secondary authentication method. User groups are aggregated across both. The user name must be exactly the same for both authentication methods, but they can require different passwords.
bindpoint Read-write Bind point to which to bind the policy. Applies only to rewrite and cache policies. If you do not set this parameter, the policy is bound to REQ_DEFAULT or RES_DEFAULT, depending on whether the policy rule is a response-time or a request-time expression.

Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST, AAA_REQUEST
__count Read-write count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • 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:// <netscaler-ip-address /nitro/v1/config/vpnvserver_authenticationoauthidppolicy_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{
"vpnvserver_authenticationoauthidppolicy_binding":{
<b>      "name":<String_value>,
</b>      "policy":<String_value>,
      "priority":<Double_value>,
      "secondary":<Boolean_value>,
      "groupextraction":<Boolean_value>,
      "gotopriorityexpression":<String_value>,
      "bindpoint":<String_value>
}}

<!--NeedCopy-->

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/vpnvserver_authenticationoauthidppolicy_binding/ name_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver_authenticationoauthidppolicy_binding/ name_value<String> ? args=policy: <String_value> ,secondary: <Boolean_value> ,groupextraction: <Boolean_value> ,bindpoint: <String_value>

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/vpnvserver_authenticationoauthidppolicy_binding/ name_value<String>

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of vpnvserver_authenticationoauthidppolicy_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/vpnvserver_authenticationoauthidppolicy_binding/ name_value<String> ? pagesize=#no;pageno=#no

Use this query-parameter to get the vpnvserver_authenticationoauthidppolicy_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 Header:

Content-Type:application/json

Response Payload: 


{  "vpnvserver_authenticationoauthidppolicy_binding": [ {
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "policy":<String_value>,
      "groupextraction":<Boolean_value>,
      "name":<String_value>,
      "secondary":<Boolean_value>,
      "bindpoint":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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 Header:

Content-Type:application/json

Response Payload: 


{  "vpnvserver_authenticationoauthidppolicy_binding": [ {
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "policy":<String_value>,
      "groupextraction":<Boolean_value>,
      "name":<String_value>,
      "secondary":<Boolean_value>,
      "bindpoint":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnvserver_authenticationoauthidppolicy_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 Header:

Content-Type:application/json

Response Payload: 


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

<!--NeedCopy-->
vpnvserver_authenticationoauthidppolicy_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.