Invoke ADCUnsetTmsamlssoprofile - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUnsetTmsamlssoprofile

SYNOPSIS

Unset Traffic Management configuration Object.

SYNTAX

Invoke-ADCUnsetTmsamlssoprofile [[-Name] <String>] [[-samlsigningcertname] <Boolean>]
 [[-sendpassword] <Boolean>] [[-samlissuername] <Boolean>] [[-relaystaterule] <Boolean>]
 [[-signaturealg] <Boolean>] [[-digestmethod] <Boolean>] [[-audience] <Boolean>] [[-nameidformat] <Boolean>]
 [[-nameidexpr] <Boolean>] [[-attribute1] <Boolean>] [[-attribute1friendlyname] <Boolean>]
 [[-attribute1format] <Boolean>] [[-attribute2] <Boolean>] [[-attribute2friendlyname] <Boolean>]
 [[-attribute2format] <Boolean>] [[-attribute3] <Boolean>] [[-attribute3friendlyname] <Boolean>]
 [[-attribute3format] <Boolean>] [[-attribute4] <Boolean>] [[-attribute4friendlyname] <Boolean>]
 [[-attribute4format] <Boolean>] [[-attribute5] <Boolean>] [[-attribute5friendlyname] <Boolean>]
 [[-attribute5format] <Boolean>] [[-attribute6] <Boolean>] [[-attribute6friendlyname] <Boolean>]
 [[-attribute6format] <Boolean>] [[-attribute7] <Boolean>] [[-attribute7friendlyname] <Boolean>]
 [[-attribute7format] <Boolean>] [[-attribute8] <Boolean>] [[-attribute8friendlyname] <Boolean>]
 [[-attribute8format] <Boolean>] [[-attribute9] <Boolean>] [[-attribute9friendlyname] <Boolean>]
 [[-attribute9format] <Boolean>] [[-attribute10] <Boolean>] [[-attribute10friendlyname] <Boolean>]
 [[-attribute10format] <Boolean>] [[-attribute11] <Boolean>] [[-attribute11friendlyname] <Boolean>]
 [[-attribute11format] <Boolean>] [[-attribute12] <Boolean>] [[-attribute12friendlyname] <Boolean>]
 [[-attribute12format] <Boolean>] [[-attribute13] <Boolean>] [[-attribute13friendlyname] <Boolean>]
 [[-attribute13format] <Boolean>] [[-attribute14] <Boolean>] [[-attribute14friendlyname] <Boolean>]
 [[-attribute14format] <Boolean>] [[-attribute15] <Boolean>] [[-attribute15friendlyname] <Boolean>]
 [[-attribute15format] <Boolean>] [[-attribute16] <Boolean>] [[-attribute16friendlyname] <Boolean>]
 [[-attribute16format] <Boolean>] [[-encryptassertion] <Boolean>] [[-samlspcertname] <Boolean>]
 [[-encryptionalgorithm] <Boolean>] [[-skewtime] <Boolean>] [[-signassertion] <Boolean>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Configuration for SAML sso action resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetTmsamlssoprofile -name <string>

An example how to unset tmsamlssoprofile configuration Object(s).

PARAMETERS

-Name

Name for the new saml 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.

Type: String
Parameter Sets: (All)
Aliases:

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

-samlsigningcertname

Name of the SSL certificate that is used to Sign Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-sendpassword

Option to send password in assertion. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-samlissuername

The name to be used in requests sent from Citrix ADC to IdP to uniquely identify Citrix ADC.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-relaystaterule

Expression to extract relaystate to be sent along with assertion. Evaluation of this expression should return TEXT content. This is typically a targ et url to which user is redirected after the recipient validates SAML token.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-signaturealg

Algorithm to be used to sign/verify SAML transactions. Possible values = RSA-SHA1, RSA-SHA256

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-digestmethod

Algorithm to be used to compute/verify digest for SAML transactions. Possible values = SHA1, SHA256

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-audience

Audience for which assertion sent by IdP is applicable. This is typically entity name or url that represents ServiceProvider.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-nameidformat

Format of Name Identifier sent in Assertion. Possible values = Unspecified, emailAddress, X509SubjectName, WindowsDomainQualifiedName, kerberos, entity, persistent, transient

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-nameidexpr

Expression that will be evaluated to obtain NameIdentifier to be sent in assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute1

Name of attribute1 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute1friendlyname

User-Friendly Name of attribute1 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute1format

Format of Attribute1 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute2

Name of attribute2 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute2friendlyname

User-Friendly Name of attribute2 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute2format

Format of Attribute2 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute3

Name of attribute3 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute3friendlyname

User-Friendly Name of attribute3 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute3format

Format of Attribute3 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute4

Name of attribute4 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute4friendlyname

User-Friendly Name of attribute4 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute4format

Format of Attribute4 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute5

Name of attribute5 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute5friendlyname

User-Friendly Name of attribute5 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute5format

Format of Attribute5 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute6

Name of attribute6 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute6friendlyname

User-Friendly Name of attribute6 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute6format

Format of Attribute6 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute7

Name of attribute7 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute7friendlyname

User-Friendly Name of attribute7 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute7format

Format of Attribute7 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute8

Name of attribute8 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute8friendlyname

User-Friendly Name of attribute8 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute8format

Format of Attribute8 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute9

Name of attribute9 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute9friendlyname

User-Friendly Name of attribute9 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute9format

Format of Attribute9 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute10

Name of attribute10 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute10friendlyname

User-Friendly Name of attribute10 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute10format

Format of Attribute10 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute11

Name of attribute11 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute11friendlyname

User-Friendly Name of attribute11 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute11format

Format of Attribute11 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute12

Name of attribute12 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute12friendlyname

User-Friendly Name of attribute12 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute12format

Format of Attribute12 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute13

Name of attribute13 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute13friendlyname

User-Friendly Name of attribute13 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute13format

Format of Attribute13 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute14

Name of attribute14 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute14friendlyname

User-Friendly Name of attribute14 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute14format

Format of Attribute14 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute15

Name of attribute15 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute15friendlyname

User-Friendly Name of attribute15 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute15format

Format of Attribute15 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute16

Name of attribute16 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute16friendlyname

User-Friendly Name of attribute16 that needs to be sent in SAML Assertion.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-attribute16format

Format of Attribute16 to be sent in Assertion. Possible values = URI, Basic

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-encryptassertion

Option to encrypt assertion when Citrix ADC sends one. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-samlspcertname

Name of the SSL certificate of peer/receving party using which Assertion is encrypted.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-encryptionalgorithm

Algorithm to be used to encrypt SAML assertion. Possible values = DES3, AES128, AES192, AES256

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-skewtime

This option specifies the number of minutes on either side of current time that the assertion would be valid. For example, if skewTime is 10, then assertion would be valid from (current time - 10) min to (current time + 10) min, ie 20min in all.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-signassertion

Option to sign portions of assertion when Citrix ADC IDP sends one. Based on the user selection, either Assertion or Response or Both or none can be signed. Possible values = NONE, ASSERTION, RESPONSE, BOTH

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 64
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-ADCUnsetTmsamlssoprofile Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/tm/tmsamlssoprofile 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** ⚠️