Add-AdfsRelyingPartyTrust
Add-AdfsRelyingPartyTrust
Adds a new relying party trust to the Federation Service.
Sintaxis
Parameter Set: AllProperties
Add-AdfsRelyingPartyTrust -Identifier <String[]> -Name <String> [-AdditionalAuthenticationRules <String> ] [-AdditionalAuthenticationRulesFile <String> ] [-AdditionalWSFedEndpoint <String[]> ] [-AutoUpdateEnabled <Boolean> ] [-ClaimAccepted <ClaimDescription[]> ] [-ClaimsProviderName <String[]> ] [-DelegationAuthorizationRules <String> ] [-DelegationAuthorizationRulesFile <String> ] [-Enabled <Boolean> ] [-EnableJWT <Boolean> ] [-EncryptClaims <Boolean> ] [-EncryptedNameIdRequired <Boolean> ] [-EncryptionCertificate <X509Certificate2> ] [-EncryptionCertificateRevocationCheck <String> ] [-ImpersonationAuthorizationRules <String> ] [-ImpersonationAuthorizationRulesFile <String> ] [-IssuanceAuthorizationRules <String> ] [-IssuanceAuthorizationRulesFile <String> ] [-IssuanceTransformRules <String> ] [-IssuanceTransformRulesFile <String> ] [-MonitoringEnabled <Boolean> ] [-NotBeforeSkew <Int32> ] [-Notes <String> ] [-PassThru] [-ProtocolProfile <String> ] [-RequestSigningCertificate <X509Certificate2[]> ] [-SamlEndpoint <SamlEndpoint[]> ] [-SamlResponseSignature <String> ] [-SignatureAlgorithm <String> ] [-SignedSamlRequestsRequired <Boolean> ] [-SigningCertificateRevocationCheck <String> ] [-TokenLifetime <Int32> ] [-WSFedEndpoint <Uri> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: MetadataFile
Add-AdfsRelyingPartyTrust -Name <String> [-AdditionalAuthenticationRules <String> ] [-AdditionalAuthenticationRulesFile <String> ] [-AutoUpdateEnabled <Boolean> ] [-ClaimsProviderName <String[]> ] [-DelegationAuthorizationRules <String> ] [-DelegationAuthorizationRulesFile <String> ] [-Enabled <Boolean> ] [-EnableJWT <Boolean> ] [-EncryptClaims <Boolean> ] [-EncryptedNameIdRequired <Boolean> ] [-EncryptionCertificateRevocationCheck <String> ] [-ImpersonationAuthorizationRules <String> ] [-ImpersonationAuthorizationRulesFile <String> ] [-IssuanceAuthorizationRules <String> ] [-IssuanceAuthorizationRulesFile <String> ] [-IssuanceTransformRules <String> ] [-IssuanceTransformRulesFile <String> ] [-MetadataFile <String> ] [-MonitoringEnabled <Boolean> ] [-NotBeforeSkew <Int32> ] [-Notes <String> ] [-PassThru] [-ProtocolProfile <String> ] [-SamlResponseSignature <String> ] [-SignatureAlgorithm <String> ] [-SignedSamlRequestsRequired <Boolean> ] [-SigningCertificateRevocationCheck <String> ] [-TokenLifetime <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: MetadataUrl
Add-AdfsRelyingPartyTrust -Name <String> [-AdditionalAuthenticationRules <String> ] [-AdditionalAuthenticationRulesFile <String> ] [-AutoUpdateEnabled <Boolean> ] [-ClaimsProviderName <String[]> ] [-DelegationAuthorizationRules <String> ] [-DelegationAuthorizationRulesFile <String> ] [-Enabled <Boolean> ] [-EnableJWT <Boolean> ] [-EncryptClaims <Boolean> ] [-EncryptedNameIdRequired <Boolean> ] [-EncryptionCertificateRevocationCheck <String> ] [-ImpersonationAuthorizationRules <String> ] [-ImpersonationAuthorizationRulesFile <String> ] [-IssuanceAuthorizationRules <String> ] [-IssuanceAuthorizationRulesFile <String> ] [-IssuanceTransformRules <String> ] [-IssuanceTransformRulesFile <String> ] [-MetadataUrl <Uri> ] [-MonitoringEnabled <Boolean> ] [-NotBeforeSkew <Int32> ] [-Notes <String> ] [-PassThru] [-ProtocolProfile <String> ] [-SamlResponseSignature <String> ] [-SignatureAlgorithm <String> ] [-SignedSamlRequestsRequired <Boolean> ] [-SigningCertificateRevocationCheck <String> ] [-TokenLifetime <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Descripción detallada
The Add-AdfsRelyingPartyTrust cmdlet adds a new relying party trust to the Federation Service. You can specify a relying party trust manually, or you can provide a federation metadata document to bootstrap initial configuration.
Parámetros
-AdditionalAuthenticationRules<String>
Specifies the additional authorization rules to require additional authentication based on user, device and location attributes after the completion of the first step of authentication. Note: These rules must only be configured after there is at least one authentication provider enabled for additional authentication.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-AdditionalAuthenticationRulesFile<String>
Specifies a file that contains the additional authentication rules to require additional authentication when a user is attempting to access this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-AdditionalWSFedEndpoint<String[]>
Specifies an array of alternate return addresses for the application. This is typically used when the application wants to indicate to AD FS what the return URL should be on successful token generation. AD FS requires that all acceptable URLs are entered as trusted information by the administrator.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
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 |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ClaimAccepted<ClaimDescription[]>
Specifies an array of claims that this relying party accepts.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByValue) |
¿Aceptar caracteres comodín? |
false |
-ClaimsProviderName<String[]>
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-DelegationAuthorizationRules<String>
Specifies the delegation authorization rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-DelegationAuthorizationRulesFile<String>
Specifies a file that contains the delegation authorization rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Enabled<Boolean>
Indicates whether the relying party trust is enabled.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EnableJWT<Boolean>
Indicates whether the JSON Web Token (JWT) format should be used to issue a token on a WS-Federation request. By default, SAML tokens are issued over WS-Federation.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EncryptClaims<Boolean>
Indicates whether the claims that are sent to the relying party are encrypted.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EncryptedNameIdRequired<Boolean>
Indicates whether the relying party requires that the NameID claim be encrypted.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EncryptionCertificate<X509Certificate2>
Specifies the certificate to be used for encrypting claims that are issued to this relying party. Encrypting claims is optional.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EncryptionCertificateRevocationCheck<String>
Specifies the type of validation that should occur for the encryption certificate it is used for encrypting claims to the relying party. Los valores aceptables para este parámetro son los siguientes:
--None
--CheckEndCert
--CheckEndCertCacheOnly
--CheckChain
--CheckChainCacheOnly
--CheckChainExcludingRoot
--CheckChainExcludingRootCacheOnly
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Identifier<String[]>
Specifies the unique identifiers for this relying party trust. No other trust can use an identifier from this list. Uniform Resource Identifiers (URIs) are often used as unique identifiers for a relying party trust, but you can use any string of characters.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ImpersonationAuthorizationRules<String>
Specifies the impersonation authorization rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-ImpersonationAuthorizationRulesFile<String>
Specifies the file that contains the impersonation authorization rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-IssuanceAuthorizationRules<String>
Specifies the issuance authorization rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-IssuanceAuthorizationRulesFile<String>
Specifies the file that contains the issuance authorization rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-IssuanceTransformRules<String>
Specifies the issuance transform rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-IssuanceTransformRulesFile<String>
Specifies the file that contains the issuance transform rules for issuing claims to this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MetadataFile<String>
Specifies a file path, such as c:\metadata.xml, that contains the federation metadata for this relying party trust.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MetadataUrl<Uri>
Specifies a URL at which the federation metadata for this relying party trust is available.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MonitoringEnabled<Boolean>
Indicates whether periodic monitoring of this relying party federation metadata is enabled. The MetadataUrl parameter specifies the URL of the relying party federation metadata.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Name<String>
Specifies the friendly name of this relying party trust.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-NotBeforeSkew<Int32>
Specifies the skew, as in integer, for the time stamp that marks the beginning of the validity period. The higher this number is, the further back in time the validity period begins with respect to the time that the claims are issued for the relying party. By default, this value is 0. Specify a positive value if validation fails on the relying party because the validity period has not yet begun.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Notes<String>
Specifies notes for this relying party trust.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-PassThru
Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ProtocolProfile<String>
Specifies which protocol profiles the relying party supports. Los valores aceptables para este parámetro son los siguientes:SAML, WsFederation, and WsFed-SAML.
The default value is WsFed-SAML.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-RequestSigningCertificate<X509Certificate2[]>
Specifies an array of certificates to be used to verify the signature on a request from the relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByValue) |
¿Aceptar caracteres comodín? |
false |
-SamlEndpoint<SamlEndpoint[]>
Specifies an array of Security Assertion Markup Language (SAML) protocol endpoints for this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
true (ByValue) |
¿Aceptar caracteres comodín? |
false |
-SamlResponseSignature<String>
Specifies the response signature or signatures that the relying party expects. Los valores aceptables para este parámetro son los siguientes:AssertionOnly, MessageAndAssertion, and MessageOnly.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-SignatureAlgorithm<String>
Specifies the signature algorithm that the relying party uses for signing and verification. Los valores aceptables para este parámetro son los siguientes:
http://www.w3.org/2000/09/xmldsig\#rsa-sha1
http://www.w3.org/2001/04/xmldsig-more\#rsa-sha256
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
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 |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-SigningCertificateRevocationCheck<String>
Specifies the type of certificate validation that occur when signatures on requests from the relying party are verified. Los valores aceptables para este parámetro son los siguientes:
-- None
-- CheckEndCert
-- CheckEndCertCacheOnly
-- CheckChain
-- CheckChainCacheOnly
-- CheckChainExcludingRoot
-- CheckChainExcludingRootCacheOnly
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-TokenLifetime<Int32>
Specifies the duration, in minutes, for which the claims that are issued to the relying party are valid.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-WSFedEndpoint<Uri>
Specifies the WS-Federation Passive URL for this relying party.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Confirm
Solicita confirmación antes de ejecutar el cmdlet.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
falso |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
Notas
- A relying party in Servicios de federación de Active Directory (AD FS) is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately accessed by the Web-based resources that are located in the relying party organization. When AD FSis configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party accesses the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server in the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party.
Ejemplos
Example 1: Add a relying party trust
This command adds a relying party trust named Fabrikam for federation.
PS C:\> Add-ADFSRelyingPartyTrust -Name "Fabrikam" -MetadataURL "https://fabrikam.com/federationmetadata/2007-06/federationmetadata.xml"