Upravit

Sdílet prostřednictvím

Remove-AdfsClaimsProviderTrust

  • Reference
Module:
ADFS

Removes a claims provider trust from the Federation Service.

Syntax

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

Description

The Remove-AdfsClaimsProviderTrust cmdlet removes a claims provider trust from the Federation Service.

Examples

Example 1: Remove a claims provider trust

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

This command removes the claims provider trust named Fabrikam 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

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

-TargetCertificate

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

Type:X509Certificate2
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetIdentifier

Specifies the identifier of the claims provider trust to remove.

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

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

System.Security.Cryptography.X509Certificates.X509Certificate.X509Certificate2

X509Certificate2 objects are received by the TargetCertificate parameter.

Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust

ClaimsProviderTrust objects are received by the TargetClaimsProviderTrust parameter.

String

String objects are received by the TargetIdentifier and TargetName parameters.

Outputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust

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

Notes

  • The claims provider collects and authenticates a user's credentials, builds up claims for that user, and packages 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), 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.