Home > Configuration > Authentication > addauthenticationloginschema

addauthenticationloginschema

Use this method to creates a LoginSchema. This profile is used to send authentication requirements to the UI tier for login

Syntax



Parameters

name

Name for the new login schema. Login schema defines the way login form is rendered. It provides a way to customize the fields that are shown to the user. 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 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.

authenticationschema

Name of the file for reading authentication schema to be sent for Login Page UI. This file should contain xml definition of elements as per Citrix Forms Authentication Protocol to be able to render login form. If administrator does not want to prompt users for additional credentials but continue with previously obtained credentials, then "noschema" can be given as argument. Please note that this applies only to loginSchemas that are used with user-defined factors, and not the vserver factor.
This is mandatory parameter.

userexpression

Expression for username extraction during login. This can be any relevant advanced policy expression.

passwdexpression

Expression for password extraction during login. This can be any relevant advanced policy expression.

usercredentialindex

The index at which user entered username should be stored in session.
Minimum value = 1.
Maximum value = 16.

passwordcredentialindex

The index at which user entered password should be stored in session.
Minimum value = 1.
Maximum value = 16.

authenticationstrength

Weight of the current authentication
Maximum value = 65535.

ssocredentials

This option indicates whether current factor credentials are the default SSO (SingleSignOn) credentials.
Default value = NO.

Return Value

Returns simpleResult

See Also