Tcl

SharePoint Get Site ID

See more SharePoint Examples

This example demonstrates how to use the Chilkat HttpCurl class together with Microsoft Graph and OAuth2 Client Credentials authentication to retrieve the ID of a SharePoint site. The example automatically obtains an access token, sends a request to Microsoft Graph to locate a site by hostname and site name, and extracts the site's ID, description, and hostname from the JSON response. The retrieved site ID can then be used in subsequent SharePoint operations such as accessing document libraries, browsing folders, and managing files. Tcl

load ./chilkat.dll

set success 0

# This example retrieves the Microsoft Graph site ID for a SharePoint site.
# 
# The site ID is required for many subsequent Microsoft Graph operations,
# such as enumerating document libraries, listing files, downloading content,
# or creating folders within a SharePoint site.

set success 0

# --------------------------------------------------------------------------------------------------------
# Before running this example, create an Azure App Registration and grant it
# the Microsoft Graph permissions required to access SharePoint.
# 
# The application will authenticate using OAuth2 Client Credentials.
# See:
# How to Create SharePoint App Registration for OAuth 2.0 Client Credentials
# --------------------------------------------------------------------------------------------------------

# Build a JSON authentication configuration.
# HttpCurl will use this information to automatically obtain OAuth2 access tokens.
set jsonAuth [new_CkJsonObject]

# Enable secret lookup.
# 
# Instead of hard-coding sensitive values such as the client ID,
# client secret, and token endpoint, secret specification strings
# are used.  Chilkat automatically retrieves the actual values from
# Windows Credential Manager (Windows) or Apple Keychain (macOS).
# 
# See:
# Secret Specification Strings
CkJsonObject_put_EnableSecrets $jsonAuth 1

set success [CkJsonObject_UpdateString $jsonAuth "oauth2.client_id" "!!sharepoint|oauth2|client_id"]
if {$success == 1} then {
    set success [CkJsonObject_UpdateString $jsonAuth "oauth2.client_secret" "!!sharepoint|oauth2|client_secret"]
}

if {$success == 1} then {
    set success [CkJsonObject_UpdateString $jsonAuth "oauth2.token_endpoint" "!!sharepoint|oauth2|token_endpoint"]
}

if {$success == 0} then {
    puts [CkJsonObject_lastErrorText $jsonAuth]
    delete_CkJsonObject $jsonAuth
    exit
}

# Request Microsoft Graph permissions that were granted to the application.
CkJsonObject_UpdateString $jsonAuth "oauth2.scope" "https://graph.microsoft.com/.default"

# ---------------------------------------------------------------------------------------------------

set curl [new_CkHttpCurl]

# Associate the OAuth2 configuration with HttpCurl.
# 
# When the request is executed, Chilkat automatically obtains an access token
# (if needed) and adds the Authorization: Bearer header to the HTTP request.
CkHttpCurl_SetAuth $curl $jsonAuth

# Define variables whose values are already known.
# 
# These variables are referenced in the curl command using
# {{variable_name}} substitution syntax.
CkHttpCurl_SetVar $curl "sharepoint_hostname" "example.sharepoint.com"
CkHttpCurl_SetVar $curl "site_name" "test"

# Define the values we want to extract from the JSON response.
# 
# The first argument is a JSON path within the response.
# The second argument is the name of the HttpCurl variable that
# will receive the extracted value.
CkHttpCurl_AddTargetOutput $curl "id" "site_id"
CkHttpCurl_AddTargetOutput $curl "description" "site_description"
CkHttpCurl_AddTargetOutput $curl "siteCollection.hostname" "site_hostname"

# Microsoft Graph request:
# 
# GET /sites/{hostname}:/sites/{site-name}
# 
# This returns information about the SharePoint site, including
# the site ID that is needed for many later SharePoint operations.
# 
# No Authorization header is included because HttpCurl automatically
# adds it when OAuth2 authentication is configured.
set curlCommand "curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{sharepoint_hostname}}:/sites/{{site_name}}\""

# Execute the request.
set success [CkHttpCurl_DoYourThing $curl $curlCommand]
if {$success == 0} then {
    puts [CkHttpCurl_lastErrorText $curl]
    delete_CkJsonObject $jsonAuth
    delete_CkHttpCurl $curl
    exit
}

# A successful Graph response should return HTTP 200.
# Any other status code typically indicates an authentication,
# permission, or resource lookup error.
set statusCode [CkHttpCurl_get_StatusCode $curl]
if {$statusCode != 200} then {
    puts [CkHttpCurl_responseBodyStr $curl]
    puts "status code = $statusCode"
    delete_CkJsonObject $jsonAuth
    delete_CkHttpCurl $curl
    exit
}

# Verify that all target outputs were successfully extracted.
# 
# The special variable name "!" tells VarDefined to return 1
# only if every target output defined by AddTargetOutput was found
# in the response JSON.
if {[CkHttpCurl_VarDefined $curl "!"] == 0} then {
    puts [CkHttpCurl_responseBodyStr $curl]
    puts "Not all target outputs were found..."
    delete_CkJsonObject $jsonAuth
    delete_CkHttpCurl $curl
    exit
}

# Display the extracted values.
puts "site_id = [CkHttpCurl_getVar $curl site_id]"
puts "site_description = [CkHttpCurl_getVar $curl site_description]"
puts "site_hostname = [CkHttpCurl_getVar $curl site_hostname]"

puts "Success."

delete_CkJsonObject $jsonAuth
delete_CkHttpCurl $curl