(Objective-C) SharePoint Get Site ID

See more SharePoint Examples

Note: This example requires Chilkat v11.5.0 or greater.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoJsonObject.h>
#import <CkoHttpCurl.h>
#import <NSString.h>

BOOL success = NO;

// 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.

success = NO;

// --------------------------------------------------------------------------------------------------------
// 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.
CkoJsonObject *jsonAuth = [[CkoJsonObject alloc] init];

// 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
jsonAuth.EnableSecrets = YES;

success = [jsonAuth UpdateString: @"oauth2.client_id" value: @"!!sharepoint|oauth2|client_id"];
if (success == YES) {
    success = [jsonAuth UpdateString: @"oauth2.client_secret" value: @"!!sharepoint|oauth2|client_secret"];
}

if (success == YES) {
    success = [jsonAuth UpdateString: @"oauth2.token_endpoint" value: @"!!sharepoint|oauth2|token_endpoint"];
}

if (success == NO) {
    NSLog(@"%@",jsonAuth.LastErrorText);
    return;
}

// Request Microsoft Graph permissions that were granted to the application.
[jsonAuth UpdateString: @"oauth2.scope" value: @"https://graph.microsoft.com/.default"];

// ---------------------------------------------------------------------------------------------------

CkoHttpCurl *curl = [[CkoHttpCurl alloc] init];

// 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.
[curl SetAuth: jsonAuth];

// Define variables whose values are already known.
// 
// These variables are referenced in the curl command using
// {{variable_name}} substitution syntax.
[curl SetVar: @"sharepoint_hostname" varValue: @"example.sharepoint.com"];
[curl SetVar: @"site_name" varValue: @"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.
[curl AddTargetOutput: @"id" varName: @"site_id"];
[curl AddTargetOutput: @"description" varName: @"site_description"];
[curl AddTargetOutput: @"siteCollection.hostname" varName: @"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.
NSString *curlCommand = @"curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{sharepoint_hostname}}:/sites/{{site_name}}\"";

// Execute the request.
success = [curl DoYourThing: curlCommand];
if (success == NO) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

// A successful Graph response should return HTTP 200.
// Any other status code typically indicates an authentication,
// permission, or resource lookup error.
int statusCode = [curl.StatusCode intValue];
if (statusCode != 200) {
    NSLog(@"%@",curl.ResponseBodyStr);
    NSLog(@"%@%d",@"status code = ",statusCode);
    return;
}

// Verify that all target outputs were successfully extracted.
// 
// The special variable name "!" tells VarDefined to return YES
// only if every target output defined by AddTargetOutput was found
// in the response JSON.
if ([curl VarDefined: @"!"] == NO) {
    NSLog(@"%@",curl.ResponseBodyStr);
    NSLog(@"%@",@"Not all target outputs were found...");
    return;
}

// Display the extracted values.
NSLog(@"%@%@",@"site_id = ",[curl GetVar: @"site_id"]);
NSLog(@"%@%@",@"site_description = ",[curl GetVar: @"site_description"]);
NSLog(@"%@%@",@"site_hostname = ",[curl GetVar: @"site_hostname"]);

NSLog(@"%@",@"Success.");