> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rassamlidp.md).

# Set-RASSAMLIDP

## SYNOPSIS

Modifies a SAMLIDP.

## SYNTAX

```powershell
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>]
```

```powershell
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>]
```

```powershell
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

```powershell
Set-RASSAMLIDP "My SAMLIDP" -Enabled $False
```

Disables the SAMLIDP specified by name.

### Example 2

```powershell
Set-RASSAMLIDP -Id 10 -Enabled $False
```

Disables the SAMLIDP specified by ID.

### Example 3

```powershell
Set-RASSAMLIDP $SAMLIDP -Enabled $False
```

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.

```yaml
Type: string
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

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

```yaml
Type: uint
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id

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

```yaml
Type: uint
Required: True
Position: 0
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -InputObject

The SAMLIDP to modify.

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

Type reference: [SAMLIDP](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/samlidp.md)

```yaml
Type: SAMLIDP
Required: True
Position: 0
Default value: None
Accept pipeline input: true (ByValue)
Accept wildcard characters: False
```

### -Enabled

Enable or disable the specified SAMLIDP in a site.

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -NewName

The new name of the target SAMLIDP.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Description

A user-defined SAMLIDP description.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ThemeId

Specifies the SAMLIDP theme.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Mode

Specifies the SAMLIDP mode.

Possible values: WebAuth, SecondLevelAuth

Type reference: [SAMLMode](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/samlmode.md)

```yaml
Type: SAMLMode
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IDPEntityID

The IDP entity ID

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IDPCertificate

The IDP certificate

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LogonURL

The logon URL

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -LogoutURL

The logout URL

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AllowUnencryptedAssertion

Allow unencrypted assertion

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Host

Host name of gateway

This specified gateway will receive the calls for SP URLs.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SPEntityId

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

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AttributeType

Specifies the attribute type

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

Type reference: [AttributeType](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/attributetype.md)

```yaml
Type: AttributeType
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AttributeEnabled

Enable or disable an attribute of a specified SAMLIDP

```yaml
Type: bool
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AttributeSAML

Specifies the SAMLIDP attribute.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -AttributeAD

Specifies the AD attribute.

```yaml
Type: string
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](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### [SAMLIDP](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/samlidp.md)

## OUTPUTS

### [SAMLIDP](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/samlidp.md) [The](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/The.md) [server](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/server.md) [or](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/or.md) [authorization](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/authorization.md) [authority](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/authority.md) [that](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/that.md) [the](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/the.md) [client](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/client.md) [can](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/can.md) [use](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/use.md) [to](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/to.md) [authenticate](https://github.com/Parallels-Corp/DI-OPS-prls-docs/tree/master/ras/API-guides/v22-PowerShell-API/RASAdmin/types/authenticate.md)

## RELATED LINKS

* [New-RASSAMLIDP](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rassamlidp.md)
* [Get-RASSAMLIDP](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rassamlidp.md)
* [Remove-RASSAMLIDP](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rassamlidp.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rassamlidp.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
