For the complete documentation index, see llms.txt. This page is also available as Markdown.

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>]
 [-Mode {WebAuth | SecondLevelAuth}] [-NewName <string>] [-SPEntityId <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>]
 [-Mode {WebAuth | SecondLevelAuth}] [-NewName <string>] [-SPEntityId <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>]
 [-Mode {WebAuth | SecondLevelAuth}] [-NewName <string>] [-SPEntityId <string>] [-ThemeId <uint>]
 [<CommonParameters>]

DESCRIPTION

Modifies properties of a SAMLIDP.

EXAMPLES

Example 1

Disables the SAMLIDP specified by name.

Example 2

Disables the SAMLIDP specified by ID.

Example 3

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

PARAMETERS

-Name

The name of the target SAMLIDP.

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

-SiteId

Site ID in which to modify the specified SAMLIDP.

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

-Id

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

-InputObject

The SAMLIDP to modify.

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

Type reference: SAMLIDP

-Enabled

Enable or disable the specified SAMLIDP in a site.

-NewName

The new name of the target SAMLIDP.

-Description

A user-defined SAMLIDP description.

-ThemeId

Specifies the SAMLIDP theme.

-Mode

Specifies the SAMLIDP mode.

Possible values: WebAuth, SecondLevelAuth

Type reference: SAMLMode

-IDPEntityID

The IDP entity ID

-IDPCertificate

The IDP certificate

-LogonURL

The logon URL

-LogoutURL

The logout URL

-AllowUnencryptedAssertion

Allow unencrypted assertion

-Host

Host name of gateway

This specified gateway will receive the calls for SP URLs.

-SPEntityId

Sends a unique Id as a parameter of the SAML token.

-AttributeType

Specifies the attribute type

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

Type reference: AttributeType

-AttributeEnabled

Enable or disable an attribute of a specified SAMLIDP

-AttributeSAML

Specifies the SAMLIDP attribute.

-AttributeAD

Specifies the AD attribute.

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

SAMLIDP

OUTPUTS

SAMLIDP The server or authorization authority that the client can use to authenticate

Last updated