Export (0) Print
Expand All
Expand Minimize

New-SPClaimTypeEncoding

SharePoint 2013
 

Applies to: SharePoint Server 2013, SharePoint Foundation 2013

Topic Last Modified: 2013-12-18

Registers a new type of claim.

New-SPClaimTypeEncoding -ClaimType <String> -EncodingCharacter <Char> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Use the New-SPClaimTypeEncoding cmdlet to register the following:

  • A new type of claim

  • The Unicode character to which it should be encoded when the SPClaim.ToEncodedString method is invoked

  • The SPClaim.ClaimType property is set to a valid value

For more information about the SPClaim methods and properties, see ToEncodedString and ClaimType respectively.

 

Parameter Required Type Description

ClaimType

Required

System.String

Specifies the type of claim for which you want to create a mapping.

EncodingCharacter

Required

System.Char

Specifies the Unicode character to which you want to create a mapping.

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.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses confirmation messages to any claim type that is added.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

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

New-SPClaimTypeEncoding -EncodingCharacter '1' -ClaimType "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country"

This example registers a new type of claim.

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