Edit

Share via

Enable-ADFSClaimsProviderTrust

  • Reference
Module:
ADFS

Enables a claims provider trust in the Federation Service.

Syntax

PowerShell 
Enable-ADFSClaimsProviderTrust
      -TargetClaimsProviderTrust <ClaimsProviderTrust>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Enable-ADFSClaimsProviderTrust
      -TargetCertificate <X509Certificate2>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
Enable-ADFSClaimsProviderTrust
      -TargetIdentifier <String>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
PowerShell 
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 --------------------------

PowerShell 
C:\PS>Enable-ADFSClaimsProviderTrust -TargetName "My claims provider"

Description

Enables a claims provider trust with the name "My claims provider".

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

Passes an object to the pipeline. 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

-TargetCertificate

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

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

-TargetClaimsProviderTrust

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

-TargetIdentifier

Specifies the identifier of the claims provider 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 claims provider trust to enable.

Type:String
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

Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust

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

Outputs

None

Notes

  • The claims provider is responsible for collecting and authenticating a user's credentials, building up claims for that user, and packaging the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to a relying party across the federation trust.