authentication loginSchema¶
The following operations can be performed on "authentication loginSchema":
add authentication loginSchema¶
Creates a LoginSchema. This profile is used to send authentication requirements to the UI tier for login
Synopsys¶
add authentication loginSchema <name> -authenticationSchema <string> [-userExpression <string>] [-passwdExpression <string>] [-userCredentialIndex <positive_integer>] [-passwordCredentialIndex <positive_integer>] [-authenticationStrength <positive_integer>] [-SSOCredentials ( YES | NO )]
Arguments¶
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 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').
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.
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
Minimum value: 0
Maximum value: 65535
SSOCredentials
This option indicates whether current factor credentials are the default SSO (SingleSignOn) credentials.
Possible values: YES, NO
Default value: NO
rm authentication loginSchema¶
Deletes an existing LoginSchema.
Synopsys¶
rm authentication loginSchema <name>
Arguments¶
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 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').
set authentication loginSchema¶
Modifies the specified attributes of a LoginSchema.
Synopsys¶
set authentication loginSchema <name> [-authenticationSchema <string>] [-userExpression <string>] [-passwdExpression <string>] [-userCredentialIndex <positive_integer>] [-passwordCredentialIndex <positive_integer>] [-authenticationStrength <positive_integer>] [-SSOCredentials ( YES | NO )]
Arguments¶
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 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').
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.
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
Minimum value: 0
Maximum value: 65535
SSOCredentials
This option indicates whether current factor credentials are the default SSO (SingleSignOn) credentials.
Possible values: YES, NO
Default value: NO
unset authentication loginSchema¶
Use this command to remove authentication loginSchema settings.Refer to the set authentication loginSchema command for meanings of the arguments.
Synopsys¶
unset authentication loginSchema <name> [-userExpression] [-passwdExpression] [-userCredentialIndex] [-passwordCredentialIndex] [-authenticationStrength] [-SSOCredentials]
show authentication loginSchema¶
Displays information about all configured login schema, or displays detailed information about the specified schema.
Synopsys¶
show authentication loginSchema [<name>]
Arguments¶
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 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').
Outputs¶
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.
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.
passwordCredentialIndex
The index at which user entered password should be stored in session.
authenticationStrength
Weight of the current authentication
SSOCredentials
This option indicates whether current factor credentials are the default SSO (SingleSignOn) credentials.
builtin
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
devno
count
stateflag