Home > Configuration > Traffic Management > addtmformssoaction

addtmformssoaction

Use this method to creates a form-based single sign-on traffic profile (action.) Form-based single sign-on allows users to access web applications that require an HTML form-based logon without having to type their password again for each new application.

Syntax



Parameters

name

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 Citrix ADC 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').
This is mandatory parameter.

actionurl

URL to which the completed form is submitted.
This is mandatory parameter.

userfield

Name of the form field in which the user types in the user ID.
This is mandatory parameter.

passwdfield

Name of the form field in which the user types in the password.
This is mandatory parameter.

ssosuccessrule

Expression, that checks to see if single sign-on is successful.
This is mandatory parameter.

namevaluepair

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

Number of bytes, in the response, to parse for extracting the forms.
Default value = 8096.

nvtype

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

submitmethod

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

Return Value

Returns simpleResult

See Also