Export (0) Print
Expand All
Expand Minimize

Remove-SPClaimTypeMapping

SharePoint 2013
 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2014-04-23

Deletes a claim type mapping rule for a security token service (STS) identity provider.

Remove-SPClaimTypeMapping [-Identity] <SPClaimMappingPipeBind> [-TrustedIdentityTokenIssuer] <SPTrustedIdentityTokenIssuerPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]

The Remove-SPClaimMapping cmdlet deletes a claim type mapping rule from a farm trust STS identity provider.

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPClaimMappingPipeBind

Specifies the claim mapping to delete.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of a claim mapping rule (for example, Email); or an instance of a valid SPClaimMapping object.

IdentityProvider

Required

Microsoft.SharePoint.PowerShell.SPTrustedIdentityTokenIssuerPipeBind

Specifies the farm trust identity provider STS that contains the claim mapping rule.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid name of identity provider (for example, LiveIDSTS); or an instance of a valid SPTrustedIdentityTokenIssuerPipeBind object.

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.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

--------------------EXAMPLE-------------------------

Remove-SPClaimMapping -Identity "Email" - TrustedIdentityTokenIssuer "LiveIDSTS"

This example removes the claim mapping EMAIL from an identity provider named LiveIDSTS.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft