(Excel) SharePoint Online Authentication

Demonstrates how to authenticate with SharePoint Online. The end result of authentication is to establish an HTTP cookie, named "SPOIDCRL", that contains a binary security token to be sent in subsequent SharePoint HTTPS requests.

The SPOIDCRL cookie can be persisted to a file and re-used in subsequent application runs.

Important: This example uses a method, SharePointOnlineAuth, that is introduced in Chilkat v9.5.0.73.

Also Important: Chilkat realizes there may be cases where your situation is such that it does not work, and something additional is required to make it work. If the example does not work out-of-the-box, please send email to support@chilkatsoft.com. The information logged to the LastErrorText property has been carefully crafted to help solve problems quickly. Also, the JSON argument to the SharePointOnlineAuth method provides a means to include additional information, whatever it may be, to handle future unknown situations.

Download Excel Class Modules Chilkat Excel Class Modules

' This requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' Change these things...
' Make sure to use "https" and end in a "/".

siteUrl = "https://mydomain.sharepoint.com/"
' The username is an email address.

username = "username@mydomain.com"

' The jsonExtra is for future use, if extra information is required for particular integrations.
Dim jsonExtra As Chilkat.JsonObject
Set jsonExtra = Chilkat.NewJsonObject

Dim ssPassword As Chilkat.SecureString
Set ssPassword = Chilkat.NewSecureString
Dim success As Boolean
success = ssPassword.Append("mypassword")

' Set properties to save/send cookies, and specify a cookie directory.
' If the CookieDir = "memory", then the SPOIDCRL cookie is persisted in memory for this HTTP object instance only.
' To persist the SharePoint authentication cookie for other HTTP objects, and for future application runs,
' set the CookieDir equal to a directory path (not a specific file path, but a directory path where cookie files
' are to be created).
http.SaveCookies = True
http.SendCookies = True
http.CookieDir = "memory"

' The SharePointOnlineAuth method is introduced in Chilkat v9.5.0.73
success = http.SharePointOnlineAuth(siteUrl,username,ssPassword,jsonExtra)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print "Success! We have the SPOIDCRL cookie..."

' SharePoint authenticated requests may now be sent because the authentication cookie is automatically included.
' For example:
Dim sbResponseXml As Chilkat.StringBuilder
Set sbResponseXml = Chilkat.NewStringBuilder
' If your Sharepoint site is within a site collection, then use "https://mydomain.sharepoint.com/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents')/Files" where "teamA" is the name of the site.
success = http.QuickGetSb("https://mydomain.sharepoint.com/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",sbResponseXml)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print "Response status code = "; http.LastStatus

Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml
success = xml.LoadSb(sbResponseXml,True)
Debug.Print xml.GetXml()