Product Documentation

tmformssoaction

Sep 08, 2016

Configuration for Form sso action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the new form-based single sign-on profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an SSO action is created.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').
Minimum length = 1
actionurl
<String>
Read-write
URL to which the completed form is submitted.
Minimum length = 1
userfield
<String>
Read-write
Name of the form field in which the user types in the user ID.
Minimum length = 1
passwdfield
<String>
Read-write
Name of the form field in which the user types in the password.
Minimum length = 1
ssosuccessrule
<String>
Read-write
Expression, that checks to see if single sign-on is successful.
namevaluepair
<String>
Read-write
Name-value pair attributes to send to the server in addition to sending the username and password. Value names are separated by an ampersand (&) (for example, name1=value1&name2=value2).
responsesize
<Double>
Read-write
Number of bytes, in the response, to parse for extracting the forms.
Default value: 8096
nvtype
<String>
Read-write
Type of processing of the name-value pair. If you specify STATIC, the values configured by the administrator are used. For DYNAMIC, the response is parsed, and the form is extracted and then submitted.
Default value: DYNAMIC
Possible values = STATIC, DYNAMIC
submitmethod
<String>
Read-write
HTTP method used by the single sign-on form to send the logon credentials to the logon server. Applies only to STATIC name-value type.
Default value: GET
Possible values = GET, POST
__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/tmformssoaction

HTTP Method: POST

Request Headers:

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

Request Payload:

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

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

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/tmformssoaction?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"tmformssoaction":{
      "name":<String_value>,
      "responsesize":true,
      "namevaluepair":true,
      "nvtype":true,
      "submitmethod":true
}}

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/tmformssoaction

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/tmformssoaction?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/tmformssoaction?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

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

{ "tmformssoaction": [ {
      "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>
}]}

get

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/tmformssoaction/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/tmformssoaction/name_value<String>?view=summary

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

Content-Type:application/json

Response Payload:

{ "tmformssoaction": [ {
      "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>
}]}

count

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

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