getauthenticationloginschemaResult Structure Definition

The getauthenticationloginschemaResult structure defines the return type for getauthenticationloginschema API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

authenticationloginschemaList

List of authenticationloginschemas


authenticationloginschema Structure Definition

The authenticationloginschema structure defines the actual return type values for getauthenticationloginschema API.

Syntax



Members

name

Name for the new login schema.

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.

_nextgenapiresource


See Also