< Back
Set-ADClaimTransformLink
Post
NAME Set-ADClaimTransformLink
SYNOPSIS
Applies a claims transformation to one or more cross-forest trust relationships in Active Directory.
SYNTAX
Set-ADClaimTransformLink [-Identity] <ADTrust> [-Policy] <ADClaimTransformPolicy> [-AuthType {Negotiate | Basic}]
[-Credential <PSCredential>] [-PassThru] [-Server <String>] -TrustRole {Trusted | Trusting} [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-ADClaimTransformLink cmdlet can be used to apply a claims transformation to one or more cross-forest trust
relationships in Active Directory.
PARAMETERS
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
Negotiate or 0
Basic or 1
The default authentication method is Negotiate.
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
The following example shows how to set this parameter to Basic.
-AuthType Basic
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the user account credentials to use to perform this task. The default credentials are the
credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell
provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the
default.
To specify this parameter, you can type a user name, such as "User1" or "Domain01\\User01" or you can specify a
PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can
then set the Credential parameter to the PSCredential object The following example shows how to create
credentials.
$AdminCredentials = Get-Credential "Domain01\\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory
PowerShell returns a terminating error.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADTrust>
Specifies an Active Directory group object by providing one of the following values. The identifier in
parentheses is the LDAP display name for the attribute.
Distinguished Name
Example: CN=fabrikam.com,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
This parameter can also get this object through the pipeline or you can set this parameter to an object
instance.
This example shows how to set this parameter to a group object instance named "ADTrustInstance".
-Identity $ADTrustInstance
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Policy <ADClaimTransformPolicy>
Specifies the claims transformation policy to apply to the cross-forest trust relationship. This parameter
does not receive pipeline input.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following
values for a corresponding domain name or directory server. The service may be any of the following: Active
Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that
they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running
under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TrustRole <ADTrustRole>
An enumeration of the link types. Used to specify which links on the trust relationships should the claims
transformation apply to. Allowable values are: Trusted and Trusting.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.ActiveDirectory.Management.ADTrust
A trust object is received by the Identity parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADTrust
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADClaimTransformPolicy DenyAllPolicy -DenyAll;
Set-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusted
Set-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusting
Description
-----------
Apply the claims transformation policy 'DenyAllPolicy' to the trust "corp.contoso.com". The rule is applied to
where this domain acts as both the trusted and trusting domain in the trust. Effectively, the rule is applied to
both claims coming in to this domain from its trust partner, and claims flowing out of this domain towards its
trust partner.
Since the specified transformation rule denies all claims to be sent or received, this domain will now deny all
claims from being sent to or received from the other domain (the trust partner).
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department;
Get-ADTrust "corp.contoso.com" | Set-ADClaimTransformLink -Policy AllowAllExceptCompanyAndDepartmentPolicy
-TrustRole Trusted
Description
-----------
Apply th the claims transformation policy 'AllowAllExceptCompanyAndDepartmentPolicy' to the trust
"corp.contoso.com". The rule is applied to where this domain acts as the trusted domain in the trust. Effectively,
the rule is applied to claims flowing out of this domain towards its trust partner.
Since the specified transformation rule allows all claims to be sent or received except 'Company' and
'Department', this domain will now allow all claims except the two from being sent to the other domain (the trust
partner).
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>New-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ce6e1cc00e9524",
Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);';
Set-ADClaimTransformLink "corp.contoso.com" -Policy HumanResourcesToHrPolicy -TrustRole Trusting
Description
-----------
Apply the claims transformation policy ' HumanResourcesToHrPolicy' to the trust "corp.contoso.com". The rule is
applied to where this domain acts as the trusting domain in the trust. Effectively, the rule is applied to claims
coming in to this domain from its trust partner.
Since the specified transformation rule transforms the value 'Human Resources' into 'HR' in the claim
ad://ext/Department:88ce6e1cc00e9524', this domain will now transform the claim value received from the other
domain (the trust partner) from 'Human Resources' to 'HR'.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291111
SYNOPSIS
Applies a claims transformation to one or more cross-forest trust relationships in Active Directory.
SYNTAX
Set-ADClaimTransformLink [-Identity] <ADTrust> [-Policy] <ADClaimTransformPolicy> [-AuthType {Negotiate | Basic}]
[-Credential <PSCredential>] [-PassThru] [-Server <String>] -TrustRole {Trusted | Trusting} [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
The Set-ADClaimTransformLink cmdlet can be used to apply a claims transformation to one or more cross-forest trust
relationships in Active Directory.
PARAMETERS
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
Negotiate or 0
Basic or 1
The default authentication method is Negotiate.
A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.
The following example shows how to set this parameter to Basic.
-AuthType Basic
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies the user account credentials to use to perform this task. The default credentials are the
credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell
provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the
default.
To specify this parameter, you can type a user name, such as "User1" or "Domain01\\User01" or you can specify a
PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.
You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can
then set the Credential parameter to the PSCredential object The following example shows how to create
credentials.
$AdminCredentials = Get-Credential "Domain01\\User01"
The following shows how to set the Credential parameter to these credentials.
-Credential $AdminCredentials
If the acting credentials do not have directory-level permission to perform the task, Active Directory
PowerShell returns a terminating error.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADTrust>
Specifies an Active Directory group object by providing one of the following values. The identifier in
parentheses is the LDAP display name for the attribute.
Distinguished Name
Example: CN=fabrikam.com,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
This parameter can also get this object through the pipeline or you can set this parameter to an object
instance.
This example shows how to set this parameter to a group object instance named "ADTrustInstance".
-Identity $ADTrustInstance
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Policy <ADClaimTransformPolicy>
Specifies the claims transformation policy to apply to the cross-forest trust relationship. This parameter
does not receive pipeline input.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Server <String>
Specifies the Active Directory Domain Services instance to connect to, by providing one of the following
values for a corresponding domain name or directory server. The service may be any of the following: Active
Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that
they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running
under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TrustRole <ADTrustRole>
An enumeration of the link types. Used to specify which links on the trust relationships should the claims
transformation apply to. Allowable values are: Trusted and Trusting.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.ActiveDirectory.Management.ADTrust
A trust object is received by the Identity parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADTrust
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADClaimTransformPolicy DenyAllPolicy -DenyAll;
Set-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusted
Set-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusting
Description
-----------
Apply the claims transformation policy 'DenyAllPolicy' to the trust "corp.contoso.com". The rule is applied to
where this domain acts as both the trusted and trusting domain in the trust. Effectively, the rule is applied to
both claims coming in to this domain from its trust partner, and claims flowing out of this domain towards its
trust partner.
Since the specified transformation rule denies all claims to be sent or received, this domain will now deny all
claims from being sent to or received from the other domain (the trust partner).
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department;
Get-ADTrust "corp.contoso.com" | Set-ADClaimTransformLink -Policy AllowAllExceptCompanyAndDepartmentPolicy
-TrustRole Trusted
Description
-----------
Apply th the claims transformation policy 'AllowAllExceptCompanyAndDepartmentPolicy' to the trust
"corp.contoso.com". The rule is applied to where this domain acts as the trusted domain in the trust. Effectively,
the rule is applied to claims flowing out of this domain towards its trust partner.
Since the specified transformation rule allows all claims to be sent or received except 'Company' and
'Department', this domain will now allow all claims except the two from being sent to the other domain (the trust
partner).
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>New-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ce6e1cc00e9524",
Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);';
Set-ADClaimTransformLink "corp.contoso.com" -Policy HumanResourcesToHrPolicy -TrustRole Trusting
Description
-----------
Apply the claims transformation policy ' HumanResourcesToHrPolicy' to the trust "corp.contoso.com". The rule is
applied to where this domain acts as the trusting domain in the trust. Effectively, the rule is applied to claims
coming in to this domain from its trust partner.
Since the specified transformation rule transforms the value 'Human Resources' into 'HR' in the claim
ad://ext/Department:88ce6e1cc00e9524', this domain will now transform the claim value received from the other
domain (the trust partner) from 'Human Resources' to 'HR'.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291111