Activate Custom Claims Provider In SharePoint 2013 Using Windows PowerShell

Introduction

A custom claims provider issues claims and packages claims into the security tokens, which can be used to give permission to the items in a customized way. Claims augmentation enables an application to augment the additional claims into the user token. Claims can be displayed in the people picker control through claims picking. In this article, I will explain how to activate Custom Claims Provider in SharePoint 2013, using Windows PowerShell.

Pre-Requisites

1. Open Visual Studio.
   
2. Open New Project dialog box. Expand Office/SharePoint node and then choose SharePoint solutions.
   
   
   
   
3. Choose SharePoint 2013 – Empty project template. Name the project as ClaimProviderProject.
   
   
   
   
4. Choose the Deploy as a farm solution option button and choose Finish button.
   
   
   
   
5. To create a custom claims provider class file, right click ClaimProviderProject project -> Add -> New Item.
   
   
   
   
6. Add the class file and name it as CustomClaimsProvider.cs.
   
   
   
   
7. Complete the implementation of custom claims provider class by overriding the SPClaimProvider properties and methods.

Activate Custom Claims Provider

1. Build this solution and take the WSP file.
   
2. Using Windows PowerShell, add WSP file to SharePoint.
   
   Add-SPSolution "D:\New folder\ClaimProviderProject\ClaimProviderProject\bin\Debug\ClaimProviderProject.wsp"
   
   
   
   
3. Install WSP file to our Web Application.
   

   Install-SPSolution -WebApplication "http:\\www.siteURL.com" -GACDeployment
   
   -FullTrustBinDeployment -Identity Ascentn.SharePoint.SettingsList.wsp
   
   -CompatibilityLevel All

   
   
   
4. Deploy the installed WSP file and enable the Claims provider feature at Farm solution level.
   

   Enable-SPFeature -Url "http:\\www.siteURL.com" -Identity CustomClaimsProvider

   
   
   
5. Check whether the custom claims provider is enabled or not, using the script, given below-
   

   Get-SPClaimProvider -Identity "CustomClaimsProvider"

   
   
   
6. Set the IsEnabled to True for the claim provider, if it is not enabled, using the script, given below-
   

   $kdealerClaimProviderDisplayName = "Custom Claims Provider"
   $manager = Get - SPClaimProviderManager
   $providers = $manager.ClaimProviders
   $provider = $providers | ? {
       $_.DisplayName - eq $kdealerClaimProviderDisplayName
   } | Select - First 1
   $provider.IsEnabled = $True
   $manager.Update()

   
   
   
7. Add the provider association to the Web Application, using the script, given below-
   

   $webUrl = "http://www.siteURL.com"
   $zone = "Default"
   $claimProviderInternalName = "CustomClaimsProvider"
   $webApplication = Get - SPWebApplication $webUrl
   if ($webApplication.IisSettings.ContainsKey($zone))
   {
       $settings = $webApplication.GetIisSettingsWithFallback($zone)
       $providers = $settings.ClaimsProviders
       if (-not($providers.Contains($claimProviderInternalName))) {
           $providers += $claimProviderInternalName
           Set - SPWebApplication - Identity $WebApplication - Zone $Zone - AdditionalClaimProvider $providers
           Write - Host "Registered $claimProviderInternalName on $($webApplication.Url) in zone $zone"
       } else {
           Write - Host "$claimProviderInternalName already registered on $($webApplication.Url) in zone $zone"
       }
   }

   
     
   
8. Check whether the custom claims provider is populated in the assigning permission to an item or not.
   
   
   

Summary

Thus, you have learned, how to activate custom claims provider in SharePoint 2013, using Windows PowerShell.