Zig Requires Chilkat v10.1.2+
Zig
Dynamics CRM OAuth2 Access Token
See more OAuth2 Examples
Demonstrates how to get a Microsoft Dynamics CRM OAuth2 access token from a desktop (installed) application or script.Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
var success: bool = false;
// To further clarify, see OAuth 2.0 Authorization Flow
const oauth2 = try chilkat.OAuth2.init();
defer oauth2.deinit();
// This should be the port in the localhost redirect URL for your app.
// Important: Make sure the redirect URI in your Azure app registration
// is exactly "http://localhost:3017/". Don't forget the ending "/" char.
// The redirect URL would look like "http://localhost:3017/" if the port number is 3017.
oauth2.setListenPort(3017);
// Get the endpoints from the Azure Portal in the "endpoints" section of App Registrations..
// The DYNAMICS-ENDPOINT-GUID is a Tenant dynamics-endpoint-guid such as 1b54e7ee-d61b-4f12-a621-a6b2805b98c2
oauth2.setAuthorizationEndpoint("https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize");
oauth2.setTokenEndpoint("https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token");
// Replace these with actual values.
oauth2.setClientId("DYNAMICS-CRM-CLIENT-ID");
oauth2.setClientSecret("DYNAMICS-CRM-SECRET-KEY");
oauth2.setResource("https://mydynamicsdomain.api.crm.dynamics.com");
oauth2.setRedirectAllowHtml("<html><body><p>Thank you for granting access.</p></bod></html>");
oauth2.setRedirectDenyHtml("<html><body><p>Maybe next time...</p></bod></html>");
// Begin the OAuth2 Authorization code flow. This returns a URL that should be loaded in a browser.
const url = oauth2.startAuth(alloc) catch {
std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
return;
};
// We can pre-check the URL by sending a GET to catch any up-front errors.
// If we receive JSON with an error in response, then we don't proceed any farther.
// If we receive an HTML response, and the response status = 200, then all should be OK.
// We can proceed by displaying an interactive browser loaded with the url.
const http = try chilkat.Http.init();
defer http.deinit();
const sb_pre_check = try chilkat.StringBuilder.init();
defer sb_pre_check.deinit();
success = if (http.quickGetSb(url, sb_pre_check)) true else |_| false;
if ((http.getLastStatus() != 200) or (!sb_pre_check.startsWith("{", true))) {
std.debug.print("JSON Error Response:\n", .{});
std.debug.print("{s}\n", .{try sb_pre_check.getAsString(alloc)});
return;
}
// If the HTTP request itself failed, then examine the error.
if (!success) {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
}
// OK.. the pre-flight check seems OK, go ahead with getting the interactive user authorization..
// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
oauth2.launchBrowser(url) catch {
std.debug.print("{s}\n", .{try oauth2.getLastErrorText(alloc)});
return;
};
// Wait for the user to approve or deny authorization in the browser.
var num_ms_waited: i32 = 0;
while ((num_ms_waited < 90000) and (oauth2.getAuthFlowState() < 3)) {
oauth2.sleepMs(100);
num_ms_waited = num_ms_waited + 100;
}
// If the browser does not respond within the specified time, AuthFlowState will be:
//
// 1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
// 2: Waiting for Final Response – The thread is awaiting the final access token response.
// In either case, cancel the background task initiated by StartAuth.
if (oauth2.getAuthFlowState() < 3) {
oauth2.cancel() catch {};
std.debug.print("No response from the browser!\n", .{});
return;
}
// Check AuthFlowState to determine if authorization was granted, denied, or failed:
//
// 3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
// 4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
// 5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.
if (oauth2.getAuthFlowState() == 5) {
std.debug.print("OAuth2 failed to complete.\n", .{});
std.debug.print("{s}\n", .{try oauth2.getFailureInfo(alloc)});
return;
}
if (oauth2.getAuthFlowState() == 4) {
std.debug.print("OAuth2 authorization was denied.\n", .{});
std.debug.print("{s}\n", .{try oauth2.getAccessTokenResponse(alloc)});
return;
}
if (oauth2.getAuthFlowState() != 3) {
std.debug.print("Unexpected AuthFlowState:{d}\n", .{oauth2.getAuthFlowState()});
return;
}
std.debug.print("OAuth2 authorization granted!\n", .{});
std.debug.print("Access Token = {s}\n", .{try oauth2.getAccessToken(alloc)});
// Get the full JSON response:
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.load(try oauth2.getAccessTokenResponse(alloc)) catch {};
json.setEmitCompact(false);
// The JSON response looks like this:
// {
// "token_type": "Bearer",
// "scope": "user_impersonation",
// "expires_in": "3599",
// "ext_expires_in": "0",
// "expires_on": "1524783438",
// "not_before": "1524779538",
// "resource": "https://mydomain.api.crm.dynamics.com",
// "access_token": "...",
// "refresh_token": "...",
// "id_token": "..."
// }
// If an "expires_on" member does not exist, then add the JSON member by
// getting the current system date/time and adding the "expires_in" seconds.
// This way we'll know when the token expires.
if (!json.hasMember("expires_on")) {
const dt_expire = try chilkat.DateTime.init();
defer dt_expire.deinit();
dt_expire.setFromCurrentSystemTime() catch {};
dt_expire.addSeconds(json.intOf("expires_in")) catch {};
json.appendString("expires_on", try dt_expire.getAsUnixTimeStr(alloc, false)) catch {};
}
std.debug.print("{s}\n", .{try json.emit(alloc)});
// Save the JSON to a file for future requests.
const fac = try chilkat.FileAccess.init();
defer fac.deinit();
fac.writeEntireTextFile("qa_data/tokens/dynamicsCrm.json", try json.emit(alloc), "utf-8", false) catch {};
}