Remove-AdfsClaimsProviderTrust
Removes a claims provider trust from the Federation Service.
Syntax
IdentifierObject
Remove-AdfsClaimsProviderTrust
-TargetClaimsProviderTrust <ClaimsProviderTrust>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
TokenSigningCertificates
Remove-AdfsClaimsProviderTrust
-TargetCertificate <X509Certificate2>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Identifier
Remove-AdfsClaimsProviderTrust
-TargetIdentifier <String>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
IdentifierName
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetCertificate
Specifies the token-signing certificate of the claims provider trust to remove.
Parameter properties
| Type: | X509Certificate2 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
TokenSigningCertificates
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | ClaimsProviderTrust |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IdentifierObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetIdentifier
Specifies the identifier of the claims provider trust to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identifier
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetName
Specifies the name of the claims provider trust to remove.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
IdentifierName
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.