(DataFlex) 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 ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoOauth2
    String sUrl
    Handle hoHttp
    Variant vSbPreCheck
    Handle hoSbPreCheck
    Boolean iSuccess
    Integer iNumMsWaited
    Handle hoJson
    Handle hoDtExpire
    Handle hoFac
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    // To further clarify, see OAuth 2.0 Authorization Flow

    Get Create (RefClass(cComChilkatOAuth2)) To hoOauth2
    If (Not(IsComObjectCreated(hoOauth2))) Begin
        Send CreateComObject of hoOauth2
    End

    // 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.
    Set ComListenPort Of hoOauth2 To 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
    Set ComAuthorizationEndpoint Of hoOauth2 To "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize"
    Set ComTokenEndpoint Of hoOauth2 To "https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token"

    // Replace these with actual values.
    Set ComClientId Of hoOauth2 To "DYNAMICS-CRM-CLIENT-ID"
    Set ComClientSecret Of hoOauth2 To "DYNAMICS-CRM-SECRET-KEY"

    Set ComResource Of hoOauth2 To "https://mydynamicsdomain.api.crm.dynamics.com"

    Set ComRedirectAllowHtml Of hoOauth2 To "<html><body><p>Thank you for granting access.</p></bod></html>"
    Set ComRedirectDenyHtml Of hoOauth2 To "<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.
    Get ComStartAuth Of hoOauth2 To sUrl
    Get ComLastMethodSuccess Of hoOauth2 To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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.
    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPreCheck
    If (Not(IsComObjectCreated(hoSbPreCheck))) Begin
        Send CreateComObject of hoSbPreCheck
    End
    Get pvComObject of hoSbPreCheck to vSbPreCheck
    Get ComQuickGetSb Of hoHttp sUrl vSbPreCheck To iSuccess
    Get ComLastStatus Of hoHttp To iTemp1
    Get ComStartsWith Of hoSbPreCheck "{" True To bTemp1
    If ((iTemp1 <> 200) Or (bTemp1 <> True)) Begin
        Showln "JSON Error Response:"
        Get ComGetAsString Of hoSbPreCheck To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // If the HTTP request itself failed, then examine the error.
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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.
    Get ComLaunchBrowser Of hoOauth2 sUrl To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Wait for the user to approve or deny authorization in the browser.
    Move 0 To iNumMsWaited
    While ((iNumMsWaited < 90000) And ((ComAuthFlowState(hoOauth2)) < 3))
        Send ComSleepMs To hoOauth2 100
        Move (iNumMsWaited + 100) To iNumMsWaited
    Loop

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

    Get ComAuthFlowState Of hoOauth2 To iTemp1
    If (iTemp1 < 3) Begin
        Get ComCancel Of hoOauth2 To iSuccess
        Showln "No response from the browser!"
        Procedure_Return
    End

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

    Get ComAuthFlowState Of hoOauth2 To iTemp1
    If (iTemp1 = 5) Begin
        Showln "OAuth2 failed to complete."
        Get ComFailureInfo Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComAuthFlowState Of hoOauth2 To iTemp1
    If (iTemp1 = 4) Begin
        Showln "OAuth2 authorization was denied."
        Get ComAccessTokenResponse Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComAuthFlowState Of hoOauth2 To iTemp1
    If (iTemp1 <> 3) Begin
        Get ComAuthFlowState Of hoOauth2 To iTemp1
        Showln "Unexpected AuthFlowState:" iTemp1
        Procedure_Return
    End

    Showln "OAuth2 authorization granted!"
    Get ComAccessToken Of hoOauth2 To sTemp1
    Showln "Access Token = " sTemp1

    // Get the full JSON response:
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComAccessTokenResponse Of hoOauth2 To sTemp1
    Get ComLoad Of hoJson sTemp1 To iSuccess
    Set ComEmitCompact Of hoJson To 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.
    Get ComHasMember Of hoJson "expires_on" To bTemp1
    If (bTemp1 <> True) Begin
        Get Create (RefClass(cComCkDateTime)) To hoDtExpire
        If (Not(IsComObjectCreated(hoDtExpire))) Begin
            Send CreateComObject of hoDtExpire
        End
        Get ComSetFromCurrentSystemTime Of hoDtExpire To iSuccess
        Get ComIntOf Of hoJson "expires_in" To iTemp1
        Get ComAddSeconds Of hoDtExpire iTemp1 To iSuccess
        Get ComGetAsUnixTimeStr Of hoDtExpire False To sTemp1
        Get ComAppendString Of hoJson "expires_on" sTemp1 To iSuccess
    End

    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1

    // Save the JSON to a file for future requests.
    Get Create (RefClass(cComCkFileAccess)) To hoFac
    If (Not(IsComObjectCreated(hoFac))) Begin
        Send CreateComObject of hoFac
    End
    Get ComEmit Of hoJson To sTemp1
    Get ComWriteEntireTextFile Of hoFac "qa_data/tokens/dynamicsCrm.json" sTemp1 "utf-8" False To iSuccess


End_Procedure