New-SPClaimTypeMapping
Applies to: SharePoint Foundation 2013, SharePoint Server 2013 Enterprise
Topic Last Modified: 2015-03-09
Creates a claim mapping rule for a security token service (STS) identity provider.
New-SPClaimTypeMapping [-IncomingClaimType] <String> [-IncomingClaimTypeDisplayName] <String> [[-LocalClaimType] <String>] [-AssignmentCollection <SPAssignmentCollection>] [-SameAsIncoming <SwitchParameter>]
The New-SPClaimTypeMapping cmdlet creates a claim mapping rule for a security token service (STS) identity provider.
SharePoint Management Shell
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| IncomingClaimType | Required | System.String | Specifies the URI of the incoming claim type. The type must be a valid URI, in the form http://schemas.microsoft.com/email. | ||
| IncomingClaimTypeDisplayName | Required | System.String | Specifies the display name of the incoming claim type. The type must be a valid name of an incoming claim type; for example, Email. | ||
| LocalClaimType | Optional | System.String | Specifies the URI of the local claim type. If the SameAsIncoming parameter is False, this is a required parameter. The type must be a valid URI, in the form http://schemas.microsoft.com/email. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| SameAsIncoming | Optional | System.Management.Automation.SwitchParameter | Specifies that the claim type specified in the IncomingClaimType parameter is used for the LocalClaimType parameter. |
--------------------EXAMPLE 1----------------------------
$map1 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress" -IncomingClaimTypeDisplayName "EmailAddress" -SameAsIncoming
$map2 = New-SPClaimTypeMapping -IncomingClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier" -IncomingClaimTypeDisplayName "PUID" -LocalClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/thumbprint"
New-SPTrustedIdentityTokenIssuer -Name "LiveIDSTS" -Description "LiveID Provider" -Realm "urn:domain.company.com" -ImportTrustCertificate $cert -ClaimsMappings $map1[,$map2..] -SignInUrl "https://login.live.com/login.srf" -IdentifierClaim $map2.InputClaimType
This example creates a claim map from an incoming token to a SharePoint token.

Note: