< Back
Set-ADClaimTransformPolicy
Post
NAME Set-ADClaimTransformPolicy
SYNOPSIS
Sets the properties of a claims transformation policy in Active Directory.
SYNTAX
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-DenyAll [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-AllowAll [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-AllowAllExcept <ADClaimType[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-DenyAllExcept <ADClaimType[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Rule <String>]
[-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server
<String>] -Instance <ADClaimTransformPolicy> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ADClaimTransformPolicy cmdlet can be used to set the properties of a claims transformation policy in
Active Directory. A claims transformation policy object contains a set of rules authored in the transformation
rule language.
PARAMETERS
-Add <Hashtable>
Specifies values to add to an object property. Use this parameter to add one or more values to a property that
cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name.
You can specify multiple values to a property by specifying a comma-separated list of values and more than one
property by separating them using a semicolon.. The format for this parameter is
-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...;
AttributeNLDAPDisplayName=value1, value2, ...}
For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and
"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value
"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as
follows.
-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove
@{otherTelephone='555-222-2222'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllowAll [<SwitchParameter>]
When this parameter is specified, the policy sets a claims transformation rule that allows all claims to be
sent or received.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllowAllExcept <ADClaimType[]>
When this parameter is specified, the policy sets a claims transformation rule that allows all claims to be
sent or received except for the specified claim types.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
-Clear <String[]>
Specifies an array of object properties that will be cleared in the directory. Use this parameter to clear one
or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property,
you must use the LDAP display name. You can modify more than one property by specifying a comma-separated
list. The format for this parameter is
-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName
For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name
'otherTelephone') set the Clear parameter as follows.
-Clear otherTelephone
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as "User01" or "Domain01\\User01", or enter a PSCredential object, such as one generated
by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.
This parameter is not supported by any providers installed with Windows PowerShell.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DenyAll [<SwitchParameter>]
When this parameter is specified, the policy sets a claims transformation rule that denies all claims to be
sent or received.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DenyAllExcept <ADClaimType[]>
When this parameter is specified, the claims transformation policy sets a claims transformation rule that
denies all claims to be sent or received except for the specified claim types.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Specifies a description of the object. This parameter sets the value of the Description property for the
object. The LDAP Display Name (ldapDisplayName) for this property is "description".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADClaimTransformPolicy>
Specifies one of the following as valid identities for the ADClaimTransformPolicy object:
Distinguished Name
Example: CN=DenyAllPolicy,CN=Claims Transformation Policies,CN=Claims
Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
The cmdlet searches the default naming context or partition to find the object. If two or more objects are
found, the cmdlet returns a non-terminating error.
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 an ADObject object instance named "ADObjectInstance".
-Identity $ADObjectInstance
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Instance <ADClaimTransformPolicy>
Specifies an instance of an Active Directory object to use as a template for a new claims transformation
policy object.
You can use an instance of an existing claims transformation policy object as a template or you can construct
a new claims transformation policy object by using the Windows PowerShell command line or by using a script.
The following examples show how to use these two methods to create a new claims transformation policy object.
Method 1: Use an existing claims transformation policy object as a template for a new object. To retrieve an
instance of an existing claims transformation policy object, use a cmdlet such as Get-ADClaimTransformPolicy.
Then provide this object to the Instance parameter of the New-ADClaimTransformPolicy cmdlet to create a new
claims transformation policy object. You can override property values of the new object by setting the
appropriate parameters.
$objectInstance = Get-ADClaimTransformPolicy -Identity "Allow All except Finance Policy"
New-ADClaimTransformPolicy -Name "Allow All Except Pii Policy" -Instance $ObjectInstance
Method 2: Create a new ADClaimTransformPolicy and set the property values by using the Windows PowerShell
command line interface. Then pass this object to the Instance parameter of the New-ADClaimTransformPolicy
cmdlet to create the new Active Directory object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
$objectInstance.Description = "For finance only."
New- DClaimTransformPolicy -Name "Deny All except Finance Policy" -Instance $ObjectInstance
Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be
set will raise an error.
Required? true
Position? named
Default value
Accept pipeline input? false
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
-ProtectedFromAccidentalDeletion <Boolean>
Specifies whether to prevent the object from being deleted. When this property is set to true, you cannot
delete the corresponding object without changing the value of the property. Possible values for this parameter
include:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Remove <Hashtable>
Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or more values
of a property that cannot be modified using a cmdlet parameter. To remove an object property, you must use the
LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format
for this parameter is
-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}
For example, if you want to add the values blue and green and remove the value pink from a property with a
LDAP display name of FavColors, set the Add and Remove parameters as follows.
-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}
When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the
following sequence:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Replace <Hashtable>
Specifies values for an object property that will replace the current values. Use this parameter to replace
one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object
property, you must use the LDAP display name. You can modify more than one property by specifying a
comma-separated list. The format for this parameter is
-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}
For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for
Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.
-Replace @{otherTelephone='555-222-2222', '555-222-1111'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Rule <String>
Represents the claims transformation rule. To specify the rule, you can either (1) type the rule in a text
file, and then pass the file to the cmdlet (recommended), or (2) type the rule inline.
For example, the following commands demonstrate how to create a new claims transformation policy object with
the rule specified in a text file named Rule.txt located in a temporary folder C:\\temp.
$rule = Get-Content C:\\temp\\rule.txt;
New-ADClaimTransformPolicy MyRule -Rule $rule
Required? false
Position? named
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
-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
None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
A claim transform policy object is received by the Identity parameter.
A claim transform policy object that was retrieved by using the Get-ADClaimTransformPolicycmdlet and then
modified is received by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
Returns the modified claim transform policy object when the PassThru parameter is specified. By default, this
cmdlet does not generate any output.
NOTES
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADClaimTransformPolicy DenyAllPolicy -DenyAll
Description
-----------
Sets the transformation rule on the claims transformation policy named 'DenyAllPolicy' to deny all claims, both
those that are sent as well as those that are received.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Set-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department
Description
-----------
Set the transformation rule on the claims transformation policy named 'AllowAllExceptCompanyAndDepartmentPolicy'
to allow all claims to be sent or received except for the claims Company and Department.
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>Set-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ce6e1cc00e9524",
Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);'
Description
-----------
Sets the transformation rule on the claims transformation policy named 'HumanResourcesToHrPolicy' to transform the
value 'Human Resources' to 'HR' in the claim 'ad://ext/Department:88ce6e1cc00e9524'.
-------------------------- EXAMPLE 4 --------------------------
C:\\PS>$rule = Get-Content C:\\rule.txt
Set-ADClaimTransformPolicy MyRule -Rule $rule
Description
-----------
Set the transformation rule on the claims transformation policy named 'MyRule' with the rule specified in
C:\\rule.txt.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291112
SYNOPSIS
Sets the properties of a claims transformation policy in Active Directory.
SYNTAX
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-DenyAll [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-AllowAll [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-AllowAllExcept <ADClaimType[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>]
-DenyAllExcept <ADClaimType[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-Identity] <ADClaimTransformPolicy> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-PassThru]
[-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Rule <String>]
[-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-ADClaimTransformPolicy [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server
<String>] -Instance <ADClaimTransformPolicy> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ADClaimTransformPolicy cmdlet can be used to set the properties of a claims transformation policy in
Active Directory. A claims transformation policy object contains a set of rules authored in the transformation
rule language.
PARAMETERS
-Add <Hashtable>
Specifies values to add to an object property. Use this parameter to add one or more values to a property that
cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name.
You can specify multiple values to a property by specifying a comma-separated list of values and more than one
property by separating them using a semicolon.. The format for this parameter is
-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...;
AttributeNLDAPDisplayName=value1, value2, ...}
For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and
"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value
"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as
follows.
-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove
@{otherTelephone='555-222-2222'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllowAll [<SwitchParameter>]
When this parameter is specified, the policy sets a claims transformation rule that allows all claims to be
sent or received.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AllowAllExcept <ADClaimType[]>
When this parameter is specified, the policy sets a claims transformation rule that allows all claims to be
sent or received except for the specified claim types.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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
-Clear <String[]>
Specifies an array of object properties that will be cleared in the directory. Use this parameter to clear one
or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property,
you must use the LDAP display name. You can modify more than one property by specifying a comma-separated
list. The format for this parameter is
-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName
For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name
'otherTelephone') set the Clear parameter as follows.
-Clear otherTelephone
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Credential <PSCredential>
Specifies a user account that has permission to perform this action. The default is the current user.
Type a user name, such as "User01" or "Domain01\\User01", or enter a PSCredential object, such as one generated
by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.
This parameter is not supported by any providers installed with Windows PowerShell.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DenyAll [<SwitchParameter>]
When this parameter is specified, the policy sets a claims transformation rule that denies all claims to be
sent or received.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DenyAllExcept <ADClaimType[]>
When this parameter is specified, the claims transformation policy sets a claims transformation rule that
denies all claims to be sent or received except for the specified claim types.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
Specifies a description of the object. This parameter sets the value of the Description property for the
object. The LDAP Display Name (ldapDisplayName) for this property is "description".
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADClaimTransformPolicy>
Specifies one of the following as valid identities for the ADClaimTransformPolicy object:
Distinguished Name
Example: CN=DenyAllPolicy,CN=Claims Transformation Policies,CN=Claims
Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
The cmdlet searches the default naming context or partition to find the object. If two or more objects are
found, the cmdlet returns a non-terminating error.
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 an ADObject object instance named "ADObjectInstance".
-Identity $ADObjectInstance
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Instance <ADClaimTransformPolicy>
Specifies an instance of an Active Directory object to use as a template for a new claims transformation
policy object.
You can use an instance of an existing claims transformation policy object as a template or you can construct
a new claims transformation policy object by using the Windows PowerShell command line or by using a script.
The following examples show how to use these two methods to create a new claims transformation policy object.
Method 1: Use an existing claims transformation policy object as a template for a new object. To retrieve an
instance of an existing claims transformation policy object, use a cmdlet such as Get-ADClaimTransformPolicy.
Then provide this object to the Instance parameter of the New-ADClaimTransformPolicy cmdlet to create a new
claims transformation policy object. You can override property values of the new object by setting the
appropriate parameters.
$objectInstance = Get-ADClaimTransformPolicy -Identity "Allow All except Finance Policy"
New-ADClaimTransformPolicy -Name "Allow All Except Pii Policy" -Instance $ObjectInstance
Method 2: Create a new ADClaimTransformPolicy and set the property values by using the Windows PowerShell
command line interface. Then pass this object to the Instance parameter of the New-ADClaimTransformPolicy
cmdlet to create the new Active Directory object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
$objectInstance.Description = "For finance only."
New- DClaimTransformPolicy -Name "Deny All except Finance Policy" -Instance $ObjectInstance
Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be
set will raise an error.
Required? true
Position? named
Default value
Accept pipeline input? false
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
-ProtectedFromAccidentalDeletion <Boolean>
Specifies whether to prevent the object from being deleted. When this property is set to true, you cannot
delete the corresponding object without changing the value of the property. Possible values for this parameter
include:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Remove <Hashtable>
Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or more values
of a property that cannot be modified using a cmdlet parameter. To remove an object property, you must use the
LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format
for this parameter is
-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}
For example, if you want to add the values blue and green and remove the value pink from a property with a
LDAP display name of FavColors, set the Add and Remove parameters as follows.
-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}
When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the
following sequence:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Replace <Hashtable>
Specifies values for an object property that will replace the current values. Use this parameter to replace
one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object
property, you must use the LDAP display name. You can modify more than one property by specifying a
comma-separated list. The format for this parameter is
-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}
For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for
Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.
-Replace @{otherTelephone='555-222-2222', '555-222-1111'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Rule <String>
Represents the claims transformation rule. To specify the rule, you can either (1) type the rule in a text
file, and then pass the file to the cmdlet (recommended), or (2) type the rule inline.
For example, the following commands demonstrate how to create a new claims transformation policy object with
the rule specified in a text file named Rule.txt located in a temporary folder C:\\temp.
$rule = Get-Content C:\\temp\\rule.txt;
New-ADClaimTransformPolicy MyRule -Rule $rule
Required? false
Position? named
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
-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
None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
A claim transform policy object is received by the Identity parameter.
A claim transform policy object that was retrieved by using the Get-ADClaimTransformPolicycmdlet and then
modified is received by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy
Returns the modified claim transform policy object when the PassThru parameter is specified. By default, this
cmdlet does not generate any output.
NOTES
This cmdlet does not work with an Active Directory Snapshot.
This cmdlet does not work with a read-only domain controller.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADClaimTransformPolicy DenyAllPolicy -DenyAll
Description
-----------
Sets the transformation rule on the claims transformation policy named 'DenyAllPolicy' to deny all claims, both
those that are sent as well as those that are received.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Set-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department
Description
-----------
Set the transformation rule on the claims transformation policy named 'AllowAllExceptCompanyAndDepartmentPolicy'
to allow all claims to be sent or received except for the claims Company and Department.
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>Set-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ce6e1cc00e9524",
Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);'
Description
-----------
Sets the transformation rule on the claims transformation policy named 'HumanResourcesToHrPolicy' to transform the
value 'Human Resources' to 'HR' in the claim 'ad://ext/Department:88ce6e1cc00e9524'.
-------------------------- EXAMPLE 4 --------------------------
C:\\PS>$rule = Get-Content C:\\rule.txt
Set-ADClaimTransformPolicy MyRule -Rule $rule
Description
-----------
Set the transformation rule on the claims transformation policy named 'MyRule' with the rule specified in
C:\\rule.txt.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291112