M365 – SharePoint Online – CSOM – Getting SharePoint client context using PnP.Framework in .NET Core application

PnP.Framework.AuthenticationManager class
PnP.Framework.AuthenticationManager class

Hi All,

LIFE IS BEAUTIFUL πŸ™‚ I hope we all are safe πŸ™‚ STAY SAFE, STAY HEALTHY,Β STAY HOME πŸ™‚

Today, in this article we will discuss how to get SharePoint Online Client Context using new PnP Framework

Take away from this article :

  • Understanding of limitation of SharePointOnlineCredentials class in .NET Core application
  • Alternative approach of getting SharePoint Online client context using PnP.Framework
  • Understanding PnP.Framework

Use Case : Following is the requirement –

  • For our M365 tenant, customer wants to remove all extra added Site Collection administrators except two from all SharePoint sites
  • We have couple of options here – PowerShell script / Console Application using CSOM
  • Since we have some existing CSOM code available so thought to re-use it and save time πŸ™‚
  • So we went for the approach – having console application and executing CSOM code

Implementation:

  • This time we have went for .NET Core console application (Visual Studio 2019) as
M365 - SharePoint Online - CSOM - Creating .NET Core console application to get the SharePoint online site context
Fig : M365 – SharePoint Online – CSOM – Creating .NET Core console application to get the SharePoint online site context
  • And then we have below sample code as usual to get the SharePoint Online site context, here we are using SharePoint admin credentials since this is one time activity. We have better options as well like using app id and secret…
SharePointOnlineCredentials spOnlineCreds = new SharePointOnlineCredentials(userName, password); //secured password string

var ctx = new ClientContext(url);
ctx.Credentials = credentials;
  • As soon as we build the project we have following error
M365 - SharePoint Online - CSOM - Getting an error for "SharePointOnlineCredentials" class in .NET Core console application
Fig : M365 – SharePoint Online – CSOM – Getting an error for “SharePointOnlineCredentials” class in .NET Core console application

Error CS0246 The type or namespace name ‘SharePointOnlineCredentials’ could not be found (are you missing a using directive or an assembly reference?)

Solution tried :

  • We make sure that proper reference “SharePoint Client” libraries and namespaces are are added
M365 - SharePoint Online - CSOM - Reference to "Microsoft.SharePoint.Client" and "Microsoft.SharePoint.Client.Runtime" is there and respective namespaces are included
Fig : M365 – SharePoint Online – CSOM – Reference to “Microsoft.SharePoint.Client” added
M365 - SharePoint Online - CSOM - Microsoft.SharePoint.Client" namespaces
Fig : M365 – SharePoint Online – CSOM – Microsoft.SharePoint.Client” namespace is included

Alternative solution / New Approach :

  • Again after bit research it found that we could use PnP.Framework
  • What is PnPFramework :
    • PnP Framework is a .NET Standard 2.0 / .NET 5.0 library targeting Microsoft 365 containing the PnP Provisioning engine and a ton of other useful extensions.
    • This library is the cross platform successor of the PnP-Sites-Core library.
    • The PnP-Sites-Core library is retired and archived.
    • This library only supports SharePoint Online

Getting SharePoint Online context using PnP Framework :

  • Make sure Nuget package for “PnP/Framework” is installed as
M365 - SharePoint Online - CSOM - using "PnP.Framework"  in .NET Core console application to get the SharePoint Online client context
Fig : M365 – SharePoint Online – CSOM – using “PnP.Framework” in .NET Core console application to get the SharePoint Online client context
  • Once we have PnP.Framework is in place, following is the sample code to get the SharePoint client context as
string siteUrl = "https://knowledgejunction1.sharepoint.com/";
string clientId = "";
string clientSecret = "";

//For SharePoint app only auth, the scope will be the SharePoint tenant name //followed by /.default
var scopes = new string[] {"https://knowledgejunction1.sharepoint.com/.default" };

using (var cc = new AuthenticationManager().GetACSAppOnlyContext(siteUrl,clientId, clientSecret))
 {
    cc.Load(cc.Web, p => p.Title);
    cc.ExecuteQuery();
    Console.WriteLine(cc.Web.Title);
 };
  1. AuthenticationManager class is available in PnP.Framework as
M365 - SharePoint Online - CSOM - using "PnP.Framework" in .NET Core console application to get the SharePoint Online client context - AuthenticationManager class
Fig : M365 – SharePoint Online – CSOM – using “PnP.Framework” in .NET Core console application to get the SharePoint Online client context – AuthenticationManager class
  • AuthenticationManager().GetACSAppOnlyContext(siteUrl,clientId, clientSecret) => returns SharePoint online Client Context – Microsoft.SharePoint.Client.ClientContext as
 M365 - SharePoint Online - CSOM - using "PnP.Framework" in .NET Core console application to get the SharePoint Online client context - AuthenticationManager.GetACSAppOnlyContext() returns SharePoint online Client Context - Microsoft.SharePoint.Client.ClientContext as
Fig : M365 – SharePoint Online – CSOM – using “PnP.Framework” in .NET Core console application to get the SharePoint Online client context – AuthenticationManager.GetACSAppOnlyContext() returns SharePoint online Client Context – Microsoft.SharePoint.Client.ClientContext as

Complete Code:

using PnP.Framework;
using System;

namespace M365ClientContextDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            string siteUrl = "https://knowledgejunction1.sharepoint.com/";
            string clientId = "";
            string clientSecret = "";

            //For SharePoint app only auth, the scope will be the SharePoint tenant name followed by /.default
            var scopes = new string[] { "https://knowledgejunction1.sharepoint.com/.default" };

            using (var cc = new AuthenticationManager().GetACSAppOnlyContext(siteUrl,clientId, clientSecret))
            {
                cc.Load(cc.Web, p => p.Title);
                cc.ExecuteQuery();
                Console.WriteLine(cc.Web.Title);

            };
        }//main

    }//cs
}//ns

References:

Thanks for readingΒ πŸ™‚ Feel free to discuss / comments / questions πŸ™‚ SHARING IS CARING πŸ™‚

Share In Teams:

Enjoy the beautiful life πŸ™‚ Have a FUN πŸ™‚ HAVE A SAFE LIFE πŸ™‚ TAKE CARE πŸ™‚

Prasham Sabadra

LIFE IS VERY BEAUTIFUL :) ENJOY THE WHOLE JOURNEY :) Founder of Knowledge Junction and live-beautiful-life.com, Author, Learner, Passionate Techie, avid reader. Certified Professional Workshop Facilitator / Public Speaker. Scrum Foundation Professional certificated. Motivational, Behavioral , Technical speaker. Speaks in various events including SharePoint Saturdays, Boot camps, Collages / Schools, local chapter. Can reach me for Microsoft 365, Azure, DevOps, SharePoint, Teams, Power Platform, JavaScript.

You may also like...

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: