Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

vpnformssoaction

August 17, 2023
Contributed by: 
C

Configuration for Form sso action resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name for the form based single sign-on profile.

Minimum length = 1
actionurl Read-write Root-relative URL to which the completed form is submitted.

Minimum length = 1
userfield Read-write Name of the form field in which the user types in the user ID.

Minimum length = 1
passwdfield Read-write Name of the form field in which the user types in the password.

Minimum length = 1
ssosuccessrule Read-write Expression that defines the criteria for SSO success. Expression such as checking for cookie in the response is a common example.
namevaluepair Read-write Other name-value pair attributes to send to the server, in addition to sending the user name and password. Value names are separated by an ampersand (;), such as in name1=value1;name2=value2.
responsesize Read-write Maximum number of bytes to allow in the response size. Specifies the number of bytes in the response to be parsed for extracting the forms.

Default value: 8096
nvtype Read-write How to process the name-value pair. Available settings function as follows
  • STATIC - The administrator-configured values are used.
  • DYNAMIC - The response is parsed, the form is extracted, and then submitted. Default value: DYNAMIC Possible values = STATIC, DYNAMIC
    		•
    submitmethod Read-write HTTP method (GET or POST) used by the single sign-on form to send the logon credentials to the logon server.

    Default value: GET

    Possible values = GET, POST
    __count Read-only count parameter

    Operations

    (click to see Properties )

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

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"vpnformssoaction":{
<b>      "name":<String_value>,
</b><b>      "actionurl":<String_value>,
</b><b>      "userfield":<String_value>,
</b><b>      "passwdfield":<String_value>,
</b><b>      "ssosuccessrule":<String_value>,
</b>      "namevaluepair":<String_value>,
      "responsesize":<Double_value>,
      "nvtype":<String_value>,
      "submitmethod":<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/vpnformssoaction/ 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

    update

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

    HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"vpnformssoaction":{
<b>      "name":<String_value>,
</b>      "actionurl":<String_value>,
      "userfield":<String_value>,
      "passwdfield":<String_value>,
      "ssosuccessrule":<String_value>,
      "responsesize":<Double_value>,
      "namevaluepair":<String_value>,
      "nvtype":<String_value>,
      "submitmethod":<String_value>
}}

<!--NeedCopy-->

    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

    unset

    URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction? action=unset

    HTTP Method: POST

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    
{"vpnformssoaction":{
<b>      "name":<String_value>,
</b>      "responsesize":true,
      "namevaluepair":true,
      "nvtype":true,
      "submitmethod":true
}}

<!--NeedCopy-->

    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 (all)

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

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    filter

    http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction? filter=property-name1:property-val1,property-name2:property-val2

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

    view

    http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction? view=summary

    Use this query-parameter to get the summary output of vpnformssoaction resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    pagination

    http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction? pagesize=#no;pageno=#no

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

    
{ "vpnformssoaction": [ {
      "name":<String_value>,
      "actionurl":<String_value>,
      "userfield":<String_value>,
      "passwdfield":<String_value>,
      "responsesize":<Double_value>,
      "namevaluepair":<String_value>,
      "nvtype":<String_value>,
      "ssosuccessrule":<String_value>,
      "submitmethod":<String_value>
}]}

<!--NeedCopy-->

    get

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

    Query-parameters:

    attrs

    http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction/ name_value<String> ? attrs=property-name1,property-name2

    Use this query parameter to specify the resource details that you want to retrieve.

    view

    http:// <netscaler-ip-address> /nitro/v1/config/vpnformssoaction/ name_value<String> ? view=summary

    Use this query-parameter to get the summary output of vpnformssoaction resources configured on NetScaler.

    Note: By default, the retrieved results are displayed in detail view (?view=detail).

    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: 

    
{  "vpnformssoaction": [ {
      "name":<String_value>,
      "actionurl":<String_value>,
      "userfield":<String_value>,
      "passwdfield":<String_value>,
      "responsesize":<Double_value>,
      "namevaluepair":<String_value>,
      "nvtype":<String_value>,
      "ssosuccessrule":<String_value>,
      "submitmethod":<String_value>
}]}

<!--NeedCopy-->

    count

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

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

<!--NeedCopy-->
    vpnformssoaction
    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.