Add-AdfsClaimsProviderTrust

Add-AdfsClaimsProviderTrust

Adds a new claims provider trust to the Federation Service.

Syntaxe

Parameter Set: AllProperties
Add-AdfsClaimsProviderTrust -Identifier <String> -Name <String> -TokenSigningCertificate <X509Certificate2[]> [-AcceptanceTransformRules <String> ] [-AcceptanceTransformRulesFile <String> ] [-AllowCreate <Boolean> ] [-AutoUpdateEnabled <Boolean> ] [-ClaimOffered <ClaimDescription[]> ] [-Enabled <Boolean> ] [-EncryptedNameIdRequired <Boolean> ] [-EncryptionCertificate <X509Certificate2> ] [-EncryptionCertificateRevocationCheck <String> ] [-MonitoringEnabled <Boolean> ] [-Notes <String> ] [-PassThru] [-ProtocolProfile <String> ] [-RequiredNameIdFormat <Uri> ] [-SamlAuthenticationRequestIndex <UInt16> ] [-SamlAuthenticationRequestParameters <String> ] [-SamlAuthenticationRequestProtocolBinding <String> ] [-SamlEndpoint <SamlEndpoint[]> ] [-SignatureAlgorithm <String> ] [-SignedSamlRequestsRequired <Boolean> ] [-SigningCertificateRevocationCheck <String> ] [-WSFedEndpoint <Uri> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: MetadataFile
Add-AdfsClaimsProviderTrust -Name <String> [-AcceptanceTransformRules <String> ] [-AcceptanceTransformRulesFile <String> ] [-AllowCreate <Boolean> ] [-AutoUpdateEnabled <Boolean> ] [-Enabled <Boolean> ] [-EncryptedNameIdRequired <Boolean> ] [-EncryptionCertificateRevocationCheck <String> ] [-MetadataFile <String> ] [-MonitoringEnabled <Boolean> ] [-Notes <String> ] [-PassThru] [-ProtocolProfile <String> ] [-RequiredNameIdFormat <Uri> ] [-SamlAuthenticationRequestIndex <UInt16> ] [-SamlAuthenticationRequestParameters <String> ] [-SamlAuthenticationRequestProtocolBinding <String> ] [-SignatureAlgorithm <String> ] [-SignedSamlRequestsRequired <Boolean> ] [-SigningCertificateRevocationCheck <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: MetadataUrl
Add-AdfsClaimsProviderTrust -Name <String> [-AcceptanceTransformRules <String> ] [-AcceptanceTransformRulesFile <String> ] [-AllowCreate <Boolean> ] [-AutoUpdateEnabled <Boolean> ] [-Enabled <Boolean> ] [-EncryptedNameIdRequired <Boolean> ] [-EncryptionCertificateRevocationCheck <String> ] [-MetadataUrl <Uri> ] [-MonitoringEnabled <Boolean> ] [-Notes <String> ] [-PassThru] [-ProtocolProfile <String> ] [-RequiredNameIdFormat <Uri> ] [-SamlAuthenticationRequestIndex <UInt16> ] [-SamlAuthenticationRequestParameters <String> ] [-SamlAuthenticationRequestProtocolBinding <String> ] [-SignatureAlgorithm <String> ] [-SignedSamlRequestsRequired <Boolean> ] [-SigningCertificateRevocationCheck <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

The Add-AdfsClaimsProviderTrust cmdlet adds a new claims provider trust to the Federation Service. Use this cmdlet when users from a partner organization need to access resources (relying parties) protected by the services de fédération Active Directory (AD FS) service. You can specify a claims provider trust manually, or you can provide a federation metadata document to bootstrap initial configuration.

Paramètres

-AcceptanceTransformRules<String>

Specifies the claim acceptance transform rules for accepting claims from this claims provider. These rules determine the information that is accepted from the partner represented by the claims provider trust.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByPropertyName)
Accepter les caractères génériques ?	false

-AcceptanceTransformRulesFile<String>

Specifies a file that contains the claim acceptance transform rules for accepting claims from the claims provider.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-AllowCreate<Boolean>

Indicates whether the Security Assertion Markup Language (SAML) parameter AllowCreate is sent in SAML requests to the claims provider. The default values $True.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-AutoUpdateEnabled<Boolean>

Indicates whether changes to the federation metadata by the MetadataURL parameter apply automatically to the configuration of the trust relationship. If this parameter has a value of $True, partner claims, certificates, and endpoints are updated automatically.

Note: When auto-update is enabled, fields that can be overwritten by metadata become read only.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-ClaimOffered<ClaimDescription[]>

Specifies an array of claims that are offered by this claims provider.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-Enabled<Boolean>

Indicates whether the claims provider trust is enabled or disabled.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-EncryptedNameIdRequired<Boolean>

Indicates whether the relying party requires that the NameID claim be encrypted. This setting applies to SAML logout requests.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-EncryptionCertificate<X509Certificate2>

Specifies the certificate to be used for encrypting a NameID to this claims provider in SAML logout requests. Encrypting the NameID is optional.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-EncryptionCertificateRevocationCheck<String>

Specifies the type of validation that occurs for the encryption certificate before it is used for encrypting claims. Les valeurs acceptables pour ce paramètre sont :

-- None
-- CheckEndCert
-- CheckEndCertCacheOnly
-- CheckChain
-- CheckChainCacheOnly
-- CheckChainExcludingRoot
-- CheckChainExcludingRootCacheOnly

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Identifier<String>

Specifies the unique identifier for this claims provider trust. No other trust can use an identifier from this list. Uniform Resource Identifiers (URIs) are often used as unique identifiers for a claims provider trust, but you can use any string of characters.

Alias	none
Obligatoire ?	true
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-MetadataFile<String>

Specifies a file path, such as c:\metadata.xml, that contains the federation metadata to be used when this claims provider trust is created.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-MetadataUrl<Uri>

Specifies a URL at which the federation metadata for this claims provider trust is available.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-MonitoringEnabled<Boolean>

Indicates whether periodic monitoring of this claims provider's federation metadata is enabled. The URL of the claims provider's federation metadata is specified by the MetadataUrl parameter.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Name<String>

Specifies the friendly name of this claims provider trust.

Alias	none
Obligatoire ?	true
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Notes<String>

Specifies notes for this claims provider trust.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-PassThru

Retourne un objet qui représente l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-ProtocolProfile<String>

Specifies which protocol profiles the claims provider supports. Les valeurs acceptables pour ce paramètre sont : SAML, WsFederation, and WsFed-SAML. The default value is WsFed-SAML.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-RequiredNameIdFormat<Uri>

Specifies the format that is required for NameID claims to be included in SAML requests to the claims provider. By default, no format is required.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-SamlAuthenticationRequestIndex<UInt16>

Specifies the value of AssertionConsumerServiceIndex that will be placed in SAML authentication requests that are sent to the claims provider.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-SamlAuthenticationRequestParameters<String>

Specifies which of the following parameters to use in SAML authentication requests to the claims provider: AssertionConsumerServiceIndex, AssertitionConsumerServiceUrl, and ProtocolBinding.Les valeurs acceptables pour ce paramètre sont : None, Index, Url, ProtocolBinding, and UrlWithProtocolBinding.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-SamlAuthenticationRequestProtocolBinding<String>

Specifies the value of ProtocolBinding to place in SAML authentication requests to the claims provider. Les valeurs acceptables pour ce paramètre sont : Artifact, Post, and Redirect.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-SamlEndpoint<SamlEndpoint[]>

Specifies an array of SAML protocol endpoints for this claims provider.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-SignatureAlgorithm<String>

Specifies the signature algorithm that the claims provider uses for signing and verification. Les valeurs acceptables pour ce paramètre sont :

http://www.w3.org/2000/09/xmldsig\#rsa-sha1
http://www.w3.org/2001/04/xmldsig-more\#rsa-sha256

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-SignedSamlRequestsRequired<Boolean>

Indicates whether the Federation Service requires signed SAML protocol requests from the relying party. If you specify a value of $True, the Federation Service rejects unsigned SAML protocol requests.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-SigningCertificateRevocationCheck<String>

Specifies the type of certificate validation that occurs when signatures are verified on responses or assertions from the claims provider. Les valeurs acceptables pour ce paramètre sont : None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-TokenSigningCertificate<X509Certificate2[]>

Specifies an array of token-signing certificates that the claims provider uses.

Alias	none
Obligatoire ?	true
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	true (ByValue)
Accepter les caractères génériques ?	false

-WSFedEndpoint<Uri>

Specifies the WS-Federation Passive URL for this claims provider.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Confirm

Votre confirmation sera requise avant l’exécution de l’applet de commande.

Obligatoire ?	false
Position ?	named
Valeur par défaut	false
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-WhatIf

Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Obligatoire ?	false
Position ?	named
Valeur par défaut	false
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.

• None

Sorties

Le type de sortie est le type des objets émis par l’applet de commande.

• None

Remarques

• 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 services de fédération Active Directory (AD FS) 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that a relying party organization hosts by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to the relying party across the federation trust.

Exemples

Example 1: Add a claims provder trust

This command adds a claims provider trust named Fabrikam that has the specified metadata URL to the Federation Service.

PS C:\> Add-AdfsClaimsProviderTrust -Name 'Fabrikam' -MetadataURL 'https://fabrikam.com/federationmetadata/2007-06/federationmetadata.xml'

Rubriques connexes

Disable-AdfsClaimsProviderTrust

Enable-AdfsClaimsProviderTrust

Get-AdfsClaimsProviderTrust

Remove-AdfsClaimsProviderTrust

Set-AdfsClaimsProviderTrust

Update-AdfsClaimsProviderTrust