Update-ADFSClaimsProviderTrust
Update-ADFSClaimsProviderTrust
Updates the claims provider trust from federation metadata.
Syntax
Parameter Set: Identifier
Update-ADFSClaimsProviderTrust -TargetIdentifier <String> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierName
Update-ADFSClaimsProviderTrust -TargetName <String> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierObject
Update-ADFSClaimsProviderTrust -TargetClaimsProviderTrust <ClaimsProviderTrust> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: TokenSigningCertificates
Update-ADFSClaimsProviderTrust -TargetCertificate <X509Certificate2> [-MetadataFile <String> ] [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Update-ADFSClaimsProviderTrust cmdlet updates the claims provider trust from federation metadata that is available at the federation metadata URL of the claims provider. This cmdlet updates claims, endpoints, and certificates.
Parameters
-MetadataFile<String>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PassThru
Passes an object to the pipeline. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TargetCertificate<X509Certificate2>
Specifies the token-signing certificate of the claims provider trust to update.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-TargetClaimsProviderTrust<ClaimsProviderTrust>
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-TargetIdentifier<String>
Specifies the identifier of the claims provider trust to update.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-TargetName<String>
Specifies the name of the claims provider trust to update.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust
A class structure that represents a claims provider trust.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
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) 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.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Update the identifier for an existing claims provider trust.
C:\PS>Update-ADFSClaimsProviderTrust -TargetName "My claims provider" -Identifier https://contoso.com/adfs/ls/