Enable-ADFSClaimsProviderTrust
Enable-ADFSClaimsProviderTrust
Enables a claims provider trust in the Federation Service.
Syntax
Parameter Set: Identifier
Enable-ADFSClaimsProviderTrust -TargetIdentifier <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierName
Enable-ADFSClaimsProviderTrust -TargetName <String> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: IdentifierObject
Enable-ADFSClaimsProviderTrust -TargetClaimsProviderTrust <ClaimsProviderTrust> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: TokenSigningCertificates
Enable-ADFSClaimsProviderTrust -TargetCertificate <X509Certificate2> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Enable-ADFSClaimsProviderTrust cmdlet enables a claims provider trust in the Federation Service.
Parameters
-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 enable.
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 enable.
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 enable.
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.
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 the claims provider trusts for the Federation Service.
Outputs
The output type is the type of the objects that the cmdlet emits.
- 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.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
Enables a claims provider trust with the name "My claims provider".
C:\PS>Enable-ADFSClaimsProviderTrust -TargetName "My claims provider"
Related topics
Disable-ADFSClaimsProviderTrust
Get-ADFSClaimsProviderTrust
Remove-ADFSClaimsProviderTrust
Set-ADFSClaimsProviderTrust
Update-ADFSClaimsProviderTrust