Invoke ADCAddAuthenticationloginschema - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCAddAuthenticationloginschema

SYNOPSIS

Add Authentication configuration Object.

SYNTAX

Invoke-ADCAddAuthenticationloginschema [-Name] <String> [-Authenticationschema] <String>
 [[-Userexpression] <String>] [[-Passwdexpression] <String>] [[-Usercredentialindex] <Double>]
 [[-Passwordcredentialindex] <Double>] [[-Authenticationstrength] <Double>] [[-Ssocredentials] <String>]
 [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for 0 resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCAddAuthenticationloginschema -name <string> -authenticationschema <string>

An example how to add authenticationloginschema configuration Object(s).

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.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Userexpression

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Passwdexpression

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Usercredentialindex

The index at which user entered username should be stored in session.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Passwordcredentialindex

The index at which user entered password should be stored in session.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Authenticationstrength

Weight of the current authentication.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Ssocredentials

This option indicates whether current factor credentials are the default SSO (SingleSignOn) credentials. Possible values = YES, NO

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: NO
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return details about the created authenticationloginschema item.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCAddAuthenticationloginschema Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/authentication/authenticationloginschema/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️