Set-RASSAMLIDP.md

NAME

Set-RASSAMLIDP

SYNOPSIS

Modifies a SAMLIDP.

SYNTAX

Set-RASSAMLIDP [Id] (uint) [AllowUnencryptedAssertion (bool)] [AttributeAD (string)] [AttributeEnabled (bool)] [AttributeSAML (string)] [-AttributeType {UserPrincipalName | ImmutableID | SID | sAMAccountName | Custom}] [Description (string)] [Enabled (bool)] [Host (string)] [IDPCertificate (string)] [IDPEntityID (string)] [LogonURL (string)] [LogoutURL (string)] [NewName (string)] [ThemeId (uint)] [(CommonParameters)]

Set-RASSAMLIDP [-InputObject] (SAMLIDP) [AllowUnencryptedAssertion (bool)] [AttributeAD (string)] [AttributeEnabled (bool)] [AttributeSAML (string)] [-AttributeType {UserPrincipalName | ImmutableID | SID | sAMAccountName | Custom}] [Description (string)] [Enabled (bool)] [Host (string)] [IDPCertificate (string)] [IDPEntityID (string)] [LogonURL (string)] [LogoutURL (string)] [NewName (string)] [ThemeId (uint)] [(CommonParameters)]

Set-RASSAMLIDP [Name] (string) [[-SiteId] (uint)] [AllowUnencryptedAssertion (bool)] [AttributeAD (string)] [AttributeEnabled (bool)] [AttributeSAML (string)] [-AttributeType {UserPrincipalName | ImmutableID | SID | sAMAccountName | Custom}] [Description (string)] [Enabled (bool)] [Host (string)] [IDPCertificate (string)] [IDPEntityID (string)] [LogonURL (string)] [LogoutURL (string)] [NewName (string)] [ThemeId (uint)] [(CommonParameters)]

DESCRIPTION

Modifies properties of a SAMLIDP.

PARAMETERS

Name (string)

The name of the target SAMLIDP.

This must be the actual SAMLIDP name used in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID in which to modify the specified SAMLIDP.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

The ID of the SAMLIDP to modify. To obtain the ID, use the Get-SAMLIDP cmdlet.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (SAMLIDP)

The SAMLIDP to modify.

To obtain an object of type SAMLIDP representing a SAMLIDP, use the Get-SAMLIDP cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

Enabled (bool)

Enable or disable the specified SAMLIDP in a site.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

NewName (string)

The new name of the target SAMLIDP.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Description (string)

A user-defined SAMLIDP description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ThemeId (uint)

Specifies the SAMLIDP theme

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

IDPEntityID (string)

The IDP entity ID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

IDPCertificate (string)

The IDP certificate

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

LogonURL (string)

The logon URL

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

LogoutURL (string)

The logout URL

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowUnencryptedAssertion (bool)

Allow unencrypted assertion

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Host (string)

Host name of gateway

This specified gateway will receive the calls for SP URLs.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AttributeType (AttributeType)

Specifies the attribute type

Possible values: UserPrincipalName, ImmutableID, SID, sAMAccountName, Custom

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AttributeEnabled (bool)

Enable or disable an attribute of a specified SAMLIDP

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AttributeSAML (string)

Specifies the SAMLIDP attribute.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AttributeAD (string)

Specifies the AD attribute.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

SAMLIDP

OUTPUTS

SAMLIDP

The

server

or

authorization

authority

that

the

client

can

use

to

authenticate

EXAMPLES

**---------- EXAMPLE 1 ----------

Set-RASSAMLIDP "My SAMLIDP" -Enabled $False

Disables the SAMLIDP specified by name. **---------- EXAMPLE 2 ----------

Set-RASSAMLIDP -Id 10 -Enabled $False

Disables the SAMLIDP specified by ID. **---------- EXAMPLE 3 ----------

Set-RASSAMLIDP $SAMLIDP -Enabled $False

Disables the SAMLIDP specified by the $SAMLIDP variable (an object of type SAMLIDP).

RELATED LINKS

• New-RASSAMLIDP

• Get-RASSAMLIDP

• Remove-RASSAMLIDP