Edit

Share via


Update-AdfsClaimsProviderTrust

Updates the claims provider trust from federation metadata.

Syntax

IdentifierObject

Update-AdfsClaimsProviderTrust
    -TargetClaimsProviderTrust <ClaimsProviderTrust>
    [-MetadataFile <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

TokenSigningCertificates

Update-AdfsClaimsProviderTrust
    -TargetCertificate <X509Certificate2>
    [-MetadataFile <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Identifier

Update-AdfsClaimsProviderTrust
    -TargetIdentifier <String>
    [-MetadataFile <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

IdentifierName

Update-AdfsClaimsProviderTrust
    -TargetName <String>
    [-MetadataFile <String>]
    [-PassThru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Update-AdfsClaimsProviderTrust cmdlet updates the claims provider trust from federation metadata.

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

-MetadataFile

Specifies a UNC file path to a file that contains the federation metadata information for the claims provider.

Parameter properties

Type:String
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

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

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 the claims provider trust to update. This value is typically taken from the pipeline.

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

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

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 updated ClaimsProviderTrust object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.