Enable-AdfsRelyingPartyTrust

  • Reference
Module:
ADFS

Enables a relying party trust of the Federation Service.

Syntax

Enable-AdfsRelyingPartyTrust
      -TargetIdentifier <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsRelyingPartyTrust
      -TargetRelyingParty <RelyingPartyTrust>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsRelyingPartyTrust
      -TargetName <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Enable-AdfsRelyingPartyTrust cmdlet enables a relying party trust of the Federation Service.

Examples

Example 1: Enable a relying party trust

PS C:\> Enable-ADFSRelyingPartyTrust -TargetName "Fabrikam01"

This command enables the relying party trust named Fabrikam01.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-TargetIdentifier

Specifies the identifier of the relying party trust to enable.

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

-TargetName

Specifies the name of the relying party trust to enable.

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

-TargetRelyingParty

Specifies a RelyingPartyTrust object. The cmdlet disables the relying party trust that you specify. To obtain a RelyingPartyTrust object, use the Get-AdfsRelyingPartyTrust cmdlet.

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

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

String objects are received by the TargetIdentifier and TargetName parameters.

Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust

RelyingPartytrust objects are received by the TargetRelyingParty parameter.

Outputs

Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust

Returns the enabled RelyingPartyTrust object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

Notes

  • A relying party in Active Directory Federation Services (AD FS) is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately accessed by the Web-based resources that are located in the relying party organization. When AD FS is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party accesses the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server in the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party.