Update-ADFSClaimsProviderTrust

  • Article

Update-ADFSClaimsProviderTrust

Updates the claims provider trust from federation metadata.

Syntax

Update-ADFSClaimsProviderTrust [-TargetName] <string> [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]

  • TargetName

  • PassThru

  • Confirm

  • WhatIf

    Update-ADFSClaimsProviderTrust [-TargetIdentityProvider] <IdentityProvider[]> [-PassThru] [-Confirm] [-WhatIf] []

  • TargetIdentityProvider

  • PassThru

  • Confirm

  • WhatIf

    Update-ADFSClaimsProviderTrust [-TargetIdentifier] [-PassThru] [-Confirm] [-WhatIf] []

  • TargetIdentifier

  • PassThru

  • Confirm

  • WhatIf

    Update-ADFSClaimsProviderTrust [-TargetCertificate] <X509Certificate2[]> [-PassThru] [-Confirm] [-WhatIf] []

  • TargetCertificate

  • PassThru

  • Confirm

  • WhatIf

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

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

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

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

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 a claims provider trust.

Return Type

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

 
Update-ADFSClaimsProviderTrust -TargetName "My claims provider" -Identifier  https://contoso.com/adfs/ls/

Description

-----------

Update the identifier for an existing claims provider trust.

See Also

Reference

Get-ADFSClaimsProviderTrust
Set-ADFSClaimsProviderTrust

Other Resources

Online version: