Connect To SharePoint Online In Office 365 Using Console Application

With SharePoint Online, we are not able to access the SharePoint Server anymore. Hence, if we have to do updates, we have to either write an app that can be deployed to SharePoint Online or we can make use of the Swiss army knife – SharePoint Management Shell to get things done. Yet another powerful and old School approach is the use of the Console Application, which can harness the power of .NET managed CSOM (Client Side Object Model) modules.



Open Visual Studio and create a console Application.



In order to work with SharePoint Client Object Model, we have to add two references to the Console Application,

• Microsoft.SharePoint.Client
• Microsoft.SharePoint.Client.Runtime

Internal Implementation walk through

Add the references to the class file,

usingSystem.Security;
usingMicrosoft.SharePoint.Client;

Once the ‘SharePoint.Client references are added, create client context for the SharePoint Online site. Use the ‘SharePointOnlineCredentials' class to authenticate the SharePoint Online site. ‘SharePointOnlineCredentials’ represents an object which provides credentials to access SharePoint Online resources.

Load the lists present within the SharePoint Online site and execute the batch by calling Context.ExecuteQuery command. This would fetch all the lists within the site, which can be looped, using a simple for loop, as shown below:

using(var context = new ClientContext(webSPOUrl))
{
    context.Credentials = new SharePointOnlineCredentials(userName, password);
    Web web = context.Web;
    context.Load(web.Lists,
        lists => lists.Include(list => list.Title,
            list => list.Id));
    context.ExecuteQuery();
    foreach(List list in web.Lists)
    {
        Console.WriteLine("List title is: " + list.Title);
    }
}

Fetching Password as Secure String from Console

In order to use the password in the below statement it should be retrieved as a secure string from the Console Application. Though we can fetch the password from the console as a string, SharePoint online credentials expects a secure string. A string would generate an error.

context.Credentials = new SharePointOnlineCredentials(userName, password);

Let’s see how we can get the secure string password from console.

string password = "";
//Read from console
ConsoleKeyInfo info = Console.ReadKey(true);
while (info.Key != ConsoleKey.Enter)
{
    //Add the password to the string variable
    if (info.Key != ConsoleKey.Backspace)
    {
        Console.Write("*");
        password += info.KeyChar;
    }
    else if (info.Key == ConsoleKey.Backspace)
    {
        //If backspace is pressed remove the character from password string
        if (!string.IsNullOrEmpty(password))
        {
            password = password.Substring(0, password.Length - 1);
            intpos = Console.CursorLeft;
            Console.SetCursorPosition(pos - 1, Console.CursorTop);
            Console.Write(" ");
            Console.SetCursorPosition(pos - 1, Console.CursorTop);
        }
    }
    info = Console.ReadKey(true);
}
Console.WriteLine();
varsecurePassword = new SecureString();
//Convert string to secure string
foreach(char c in password)
securePassword.AppendChar(c);
securePassword.MakeReadOnly();
returnsecurePassword;

The full working code is shown below:

using System;
usingSystem.Security;
usingMicrosoft.SharePoint.Client;
usingSystem.Collections.Generic;
usingSystem.Linq;
usingSystem.Text;
usingSystem.Threading.Tasks;
namespaceConnectToSPO
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("SharePoint Online site URL:");
            stringwebSPOUrl = Console.ReadLine();
            Console.WriteLine("User Name:");
            stringuserName = Console.ReadLine();
            Console.WriteLine("Password:");
            SecureString password = FetchPasswordFromConsole();
            try
            {
                using(var context = new ClientContext(webSPOUrl))
                {
                    context.Credentials = new SharePointOnlineCredentials(userName, password);
                    Web web = context.Web;
                    context.Load(web.Lists,
                        lists => lists.Include(list => list.Title,
                            list => list.Id));
                    context.ExecuteQuery();
                    Console.ForegroundColor = ConsoleColor.White;
                    foreach(List list in web.Lists)
                    {
                        Console.WriteLine("List title is: " + list.Title);
                    }
                    Console.WriteLine("");
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine("Error is: " + ex.Message);
            }
        }
        private static SecureStringFetchPasswordFromConsole()
        {
            string password = "";
            ConsoleKeyInfo info = Console.ReadKey(true);
            while (info.Key != ConsoleKey.Enter)
            {
                if (info.Key != ConsoleKey.Backspace)
                {
                    Console.Write("*");
                    password += info.KeyChar;
                }
                else if (info.Key == ConsoleKey.Backspace)
                {
                    if (!string.IsNullOrEmpty(password))
                    {
                        password = password.Substring(0, password.Length - 1);
                        intpos = Console.CursorLeft;
                        Console.SetCursorPosition(pos - 1, Console.CursorTop);
                        Console.Write(" ");
                        Console.SetCursorPosition(pos - 1, Console.CursorTop);
                    }
                }
                info = Console.ReadKey(true);
            }
            Console.WriteLine();
            varsecurePassword = new SecureString();
            //Convert string to secure string
            foreach(char c in password)
            securePassword.AppendChar(c);
            securePassword.MakeReadOnly();
            returnsecurePassword;
        }
    }
}

Output



Thus, we have seen how to access SharePoint Online, using Console Application remotely. This Console Application can be used to run on a schedule, using Windows task scheduler and it can be made to perform updates/operations in SharePoint Online. This can be used as an alternative to the SharePoint Timer job, which is present in SharePoint on premise.