Add-AdfsClaimsProviderTrust

  • [アーティクル]

Add-AdfsClaimsProviderTrust

Adds a new claims provider trust to the Federation Service.

構文

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

詳細説明

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

パラメーター

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByPropertyName)

ワイルドカード文字を許可する

false

-AcceptanceTransformRulesFile<String>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ClaimOffered<ClaimDescription[]>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-Enabled<Boolean>

Indicates whether the claims provider trust is enabled or disabled.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-EncryptedNameIdRequired<Boolean>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-EncryptionCertificateRevocationCheck<String>

Specifies the type of validation that occurs for the encryption certificate before it is used for encrypting claims. このパラメーターに対して使用できる値:

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-MetadataUrl<Uri>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Name<String>

Specifies the friendly name of this claims provider trust.

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Notes<String>

Specifies notes for this claims provider trust.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-ProtocolProfile<String>

Specifies which protocol profiles the claims provider supports. このパラメーターに対して使用できる値: SAML, WsFederation, and WsFed-SAML. The default value is WsFed-SAML.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SamlAuthenticationRequestIndex<UInt16>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SamlAuthenticationRequestParameters<String>

Specifies which of the following parameters to use in SAML authentication requests to the claims provider: AssertionConsumerServiceIndex, AssertitionConsumerServiceUrl, and ProtocolBinding.このパラメーターに対して使用できる値: None, Index, Url, ProtocolBinding, and UrlWithProtocolBinding.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SamlAuthenticationRequestProtocolBinding<String>

Specifies the value of ProtocolBinding to place in SAML authentication requests to the claims provider. このパラメーターに対して使用できる値: Artifact, Post, and Redirect.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SamlEndpoint<SamlEndpoint[]>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-SignatureAlgorithm<String>

Specifies the signature algorithm that the claims provider uses for signing and verification. このパラメーターに対して使用できる値:

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

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.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-SigningCertificateRevocationCheck<String>

Specifies the type of certificate validation that occurs when signatures are verified on responses or assertions from the claims provider. このパラメーターに対して使用できる値: None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly.

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-TokenSigningCertificate<X509Certificate2[]>

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

エイリアス

なし

必須?

true

位置は?

named

既定値

なし

パイプライン入力を許可する

true (ByValue)

ワイルドカード文字を許可する

false

-WSFedEndpoint<Uri>

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

エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?

false

位置は?

named

既定値

false

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

  • None

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • None

注

  • 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 フェデレーション サービス (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.

例

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'

関連トピック

Disable-AdfsClaimsProviderTrust

Enable-AdfsClaimsProviderTrust

Get-AdfsClaimsProviderTrust

Remove-AdfsClaimsProviderTrust

Set-AdfsClaimsProviderTrust

Update-AdfsClaimsProviderTrust