(C#) 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.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat .NET Downloads

Chilkat .NET Framework

Chilkat for .NET Core

// To further clarify, see OAuth 2.0 Authorization Flow

Chilkat.OAuth2 oauth2 = new Chilkat.OAuth2();

// 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.ListenPort = 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.AuthorizationEndpoint = "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize";
oauth2.TokenEndpoint = "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token";

// Replace these with actual values.
oauth2.ClientId = "DYNAMICS-CRM-CLIENT-ID";
oauth2.ClientSecret = "DYNAMICS-CRM-SECRET-KEY";

oauth2.Resource = "https://mydynamicsdomain.api.crm.dynamics.com";

oauth2.RedirectAllowHtml = "<html><body><p>Thank you for granting access.</p></bod></html>";
oauth2.RedirectDenyHtml = "<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.
string url = oauth2.StartAuth();
if (oauth2.LastMethodSuccess != true) {
    Debug.WriteLine(oauth2.LastErrorText);
    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.
Chilkat.Http http = new Chilkat.Http();
Chilkat.StringBuilder sbPreCheck = new Chilkat.StringBuilder();
bool success = http.QuickGetSb(url,sbPreCheck);
if ((http.LastStatus != 200) || (sbPreCheck.StartsWith("{",true) != true)) {
    Debug.WriteLine("JSON Error Response:");
    Debug.WriteLine(sbPreCheck.GetAsString());
    return;
}

// If the HTTP request itself failed, then examine the error.
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    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.
success = oauth2.LaunchBrowser(url);
if (success == false) {
    Debug.WriteLine(oauth2.LastErrorText);
    return;
}

// Wait for the user to approve or deny authorization in the browser.
int numMsWaited = 0;
while ((numMsWaited < 90000) && (oauth2.AuthFlowState < 3)) {
    oauth2.SleepMs(100);
    numMsWaited = numMsWaited + 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.AuthFlowState < 3) {
    oauth2.Cancel();
    Debug.WriteLine("No response from the browser!");
    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.AuthFlowState == 5) {
    Debug.WriteLine("OAuth2 failed to complete.");
    Debug.WriteLine(oauth2.FailureInfo);
    return;
}

if (oauth2.AuthFlowState == 4) {
    Debug.WriteLine("OAuth2 authorization was denied.");
    Debug.WriteLine(oauth2.AccessTokenResponse);
    return;
}

if (oauth2.AuthFlowState != 3) {
    Debug.WriteLine("Unexpected AuthFlowState:" + Convert.ToString(oauth2.AuthFlowState));
    return;
}

Debug.WriteLine("OAuth2 authorization granted!");
Debug.WriteLine("Access Token = " + oauth2.AccessToken);

// Get the full JSON response:
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.Load(oauth2.AccessTokenResponse);
json.EmitCompact = 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") != true) {
    Chilkat.CkDateTime dtExpire = new Chilkat.CkDateTime();
    dtExpire.SetFromCurrentSystemTime();
    dtExpire.AddSeconds(json.IntOf("expires_in"));
    json.AppendString("expires_on",dtExpire.GetAsUnixTimeStr(false));
}

Debug.WriteLine(json.Emit());

// Save the JSON to a file for future requests.
Chilkat.FileAccess fac = new Chilkat.FileAccess();
fac.WriteEntireTextFile("qa_data/tokens/dynamicsCrm.json",json.Emit(),"utf-8",false);