Enable-ADFSClaimsProviderTrust
Enable-ADFSClaimsProviderTrust
Enables a claims provider trust in the Federation Service.
Syntax
Enable-ADFSClaimsProviderTrust [-TargetName] <string> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]
TargetName
PassThru
Confirm
WhatIf
Enable-ADFSClaimsProviderTrust [-TargetIdentityProvider] <IdentityProvider[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetIdentityProvider
PassThru
Confirm
WhatIf
Enable-ADFSClaimsProviderTrust [-TargetIdentifier] [-PassThru] [-Confirm] [-WhatIf] []
TargetIdentifier
PassThru
Confirm
WhatIf
Enable-ADFSClaimsProviderTrust [-TargetCertificate] <X509Certificate2[]> [-PassThru] [-Confirm] [-WhatIf] []
TargetCertificate
PassThru
Confirm
WhatIf
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.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
TargetCertificate
Specifies the token-signing certificate of the claims provider trust to enable.
Default Value: **
Data Type: X509Certificate2[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
TargetIdentifier
Specifies the identifier of the claims provider trust to enable.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
TargetIdentityProvider
Specifies the claims provider trust to enable. This value is typically taken from the pipeline.
Default Value: **
Data Type: IdentityProvider[]
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
true |
variableLength |
TargetName
Specifies the name of the claims provider trust to enable.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Confirm
Prompts you for confirmation before executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
WhatIf
Describes what would happen if you executed the command without actually executing the command.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
true |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust
A class structure that represents the claims provider trusts for the Federation Service.
Return Type
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. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens 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 can be presented to a relying party across the federation trust.
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Enable-ADFSClaimsProviderTrust -TargetName "My claims provider"
Description
-----------
Enables a claims provider trust with the name "My claims provider".
See Also
Reference
Get-ADFSClaimsProviderTrust
Remove-ADFSClaimsProviderTrust
Set-ADFSClaimsProviderTrust
Disable-ADFSClaimsProviderTrust
Update-ADFSClaimsProviderTrust