New-AdfsLdapAttributeToClaimMapping
Creates a mapping between an attribute of an LDAP folder and an AD FS claim type.
Syntax
Default (Default)
New-AdfsLdapAttributeToClaimMapping
[-LdapAttribute] <String>
[[-ClaimType] <String>]
[<CommonParameters>]
Description
The New-AdfsLdapAttributeToClaimMapping cmdlet creates a mapping between an attribute of the Lightweight Directory Access Protocol (LDAP) folder and an Active Directory Federation Services (AD FS) claim type. Mappings make it possible for LDAP attributes to be available for claim rule processing in AD FS.
Examples
Example 1: Create a mapping of an LDAP directory attribute
PS C:\> $DisplayName = New-AdfsLdapAttributeToClaimMapping -LdapAttribute "displayName" -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/displayname"
This command creates a mapping of an LDAP directory attribute to a claim type. The command stores the mapping in the $DisplayName variable for use with other cmdlets.
To see this cmdlet as part of creating an LDAP local claims provider trust, see the Add-AdfsLocalClaimsProviderTrust cmdlet.
Parameters
-ClaimType
Specifies the claim type to assign to the AD FS claim that contains the LDAP attribute value.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LdapAttribute
Specifies the attribute in the LDAP folder to which the claim type is mapped.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.