Enable-Adfs Claims Provider Trust

Module:
adfs
Enables a claims provider trust in the Federation Service.

Syntax 

Enable-AdfsClaimsProviderTrust
      -TargetClaimsProviderTrust <ClaimsProviderTrust>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsClaimsProviderTrust
      -TargetCertificate <X509Certificate2>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsClaimsProviderTrust
      -TargetIdentifier <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Enable-AdfsClaimsProviderTrust
      -TargetName <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Enable-AdfsClaimsProviderTrust cmdlet enables a claims provider trust in the Federation Service.

Examples

Example 1: Enable a claims provider trust 

PS C:\> Enable-AdfsClaimsProviderTrust -TargetName "Fabrikam claims provider"

This command enables a claims provider trust with the name Fabrikam claims provider.

Required Parameters

-TargetCertificate

Specifies the token-signing certificate of the claims provider trust to enable.

Type: X509Certificate2
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-TargetClaimsProviderTrust

Specifies a ClaimsProviderTrust object. The cmdlet enables the claims provider trust that you specify. To obtain a ClaimsProviderTrust object, use the Get-AdfsClaimsProviderTrust cmdlet.

Type: ClaimsProviderTrust
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-TargetIdentifier

Specifies the identifier of the claims provider trust to enable.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-TargetName

Specifies the name of the claims provider trust to enable.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: 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
Accept pipeline input: False
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
Accept pipeline input: False
Accept wildcard characters: False

Inputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust

A class structure that represents the claims provider trusts for the Federation Service.

Outputs

None

Notes

  • A relying party in Active Directory Federation Services (AD FS) 2.0 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 2.0 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.