Set-ADClaimTransformPolicy
Synopsis
Description
Parameters
-Add
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
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:
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
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.
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:
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.
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:
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
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
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.
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.
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? falseSyntax
Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add <Hashtable>] -AllowAllExcept <ADClaimType[]> [-AuthType <ADAuthType>] [-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-Identity] <ADClaimTransformPolicy> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [<CommonParameters>]
Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AllowAll] [-AuthType <ADAuthType>] [-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-Identity] <ADClaimTransformPolicy> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [<CommonParameters>]
Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-Clear <String[]>] [-Credential <PSCredential>] [-DenyAll] [-Description <String>] [-Identity] <ADClaimTransformPolicy> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [<CommonParameters>]
Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-Clear <String[]>] [-Credential <PSCredential>] -DenyAllExcept <ADClaimType[]> [-Description <String>] [-Identity] <ADClaimTransformPolicy> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Server <String>] [<CommonParameters>]
Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-Identity] <ADClaimTransformPolicy> [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean>] [-Remove <Hashtable>] [-Replace <Hashtable>] [-Rule <String>] [-Server <String>] [<CommonParameters>]
Set- ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Instance <ADClaimTransformPolicy> [-PassThru] [-Server <String>] [<CommonParameters>]
This cmdlet does not work with an Active Directory Snapshot.
C:\PS>Set- ADClaimTransformPolicy DenyAllPol -DenyAll
Sets the transformation rule on the claims transformation policy named ‘DenyAllPol’ to deny all claims, both those that are sent as well as those that are received.
C:\PS>Set- ADClaimTransformPolicy AllowAllExceptCAndDPolicy -AllowAllExcept Company,Department
Set the transformation rule on the claims transformation policy named ‘AllowAllExceptCAndDPolicy’ to allow all claims to be sent or received except for the claims Company and Department.
C:\PS>Set- ADClaimTransformPolicy HRToHrPolicy -Rule ‘C1:[Type==”ad://ext/Department:54sd3e3cc00e9524″, Value==”Human Resources”, ValueType==”string”] => issue(Type=C1.Type, Value=”HR”, ValueType=C1.ValueType);’
Sets the transformation rule on the claims transformation policy named ‘HRToHrPolicy’ to transform the value ‘Human Resources’ to ‘HR’ in the claim ‘ad://ext/Department:54sd3e3cc00e9524’.
C:\PS>$rule = Get-Content C:\myrule.txt
Set- ADClaimTransformPolicy MyRule -Rule $rule
Set the transformation rule on the claims transformation policy named ‘MyRule’ with the rule specified in C:\myrule.txt.
Get-Command Set-ADClaimTransformPolicy
