SPWebApplication.MigrateUsersToClaims method (NTAccount, Boolean, SPWebApplication.SPMigrateUserParameters)

SharePoint 2013

Migrates users from legacy authentication to claims-based authentication.

Namespace:  Microsoft.SharePoint.Administration
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

'Declaration
Public Function MigrateUsersToClaims ( _
	account As NTAccount, _
	removePermissionsAfter As Boolean, _
	parameters As SPWebApplication.SPMigrateUserParameters _
) As Boolean
'Usage
Dim instance As SPWebApplication
Dim account As NTAccount
Dim removePermissionsAfter As Boolean
Dim parameters As SPWebApplication.SPMigrateUserParameters
Dim returnValue As Boolean

returnValue = instance.MigrateUsersToClaims(account, _
	removePermissionsAfter, parameters)

Parameters

account
Type: System.Security.Principal.NTAccount

The NTAccount that will perform the operation.

removePermissionsAfter
Type: System.Boolean

The account is given the correct permissions to perform the operation. Indicates whether the permission should be removed when the operation is completed.

parameters
Type: Microsoft.SharePoint.Administration.SPWebApplication.SPMigrateUserParameters

This defines the scope and type of migration operation to be performed.

Return value

Type: System.Boolean
true if successful; otherwise, false.
Show: