Edit

New-ADFSClaimRuleSet

  • Reference
Module:
ADFS

Creates a new set of claim rules.

Syntax

New-ADFSClaimRuleSet
   -ClaimRule <String[]>
   [<CommonParameters>]
New-ADFSClaimRuleSet
   -ClaimRuleFile <String>
   [<CommonParameters>]

Description

The New-ADFSClaimRuleSet cmdlet creates a new set of claim rules in Active Directory Federation Services (AD FS) 2.0.

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS>$rSet = New-ADFSClaimRuleSet -ClaimRuleFile 'C:\ruleset.txt'
Set-ADFSRelyingPartyTrust -TargetName Fabrikam -IssuanceTransformRules $rSet.ClaimRulesString

Description

Creates a new claim rule set for a relying party trust using a text file.

-------------------------- EXAMPLE 2 --------------------------

C:\PS>$rSet = New-ADFSClaimRuleSet -ClaimRule 'c:[] => issue(claim = c);'
Set-ADFSRelyingPartyTrust -TargetName Fabrikam -IssuanceTransformRules $rSet.ClaimRulesString

Description

Creates a new claim rule set for a relying party trust using an inline AD FS 2.0 claims language rule.

Parameters

-ClaimRule

Specifies the individual rules in this rule set.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ClaimRuleFile

Specifies the serialized policy text that is created by the collection of rules in the rule set.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Microsoft.IdentityServer.PowerShell.Resources.ClaimRuleSet

A class structure that represents a set of AD FS 2.0 claim rules.

Notes

  • You can assign these claim rules to a claims provider trust or relying party trust by using the corresponding cmdlets.