SQL Server

Refresh a Dynamics CRM OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to refresh an expiring Dynamics CRM access token using the refresh token. endpoint.

(If a REST API call fails with a 401 unauthorized error, an application can auto-recover by refreshing the access token, and then re-send the request using the new token.)

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- We previously obtained an access token and saved the JSON to a file using this example:
    -- Get Dynamics CRM OAuth2 Access Token

    -- This example will examine the JSON and expiration date, and if near expiration will
    -- refresh the access token.

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OAMethod @json, 'LoadFile', @success OUT, 'qa_data/tokens/dynamicsCrm.json'
    IF @success <> 1
      BEGIN
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- The contents of the JSON look 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": "..."
    -- }

    -- The "expires_on" value is a Unix time.
    DECLARE @dtExpire int
    EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @dtExpire OUT

    EXEC sp_OAMethod @json, 'IntOf', @iTmp0 OUT, 'expires_on'
    EXEC sp_OAMethod @dtExpire, 'SetFromUnixTime', @success OUT, 0, @iTmp0

    -- If this date/time expires within 10 minutes of the current system time, refresh the token.

    -- OK, we need to refresh the access token by sending a POST...
    -- 

    DECLARE @req int
    EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'grant_type', 'refresh_token'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'redirect_uri', 'http://localhost:3017/'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'client_id', 'DYNAMICS-CRM-CLIENT-ID'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'client_secret', 'DYNAMICS-CRM-SECRET-KEY'
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'refresh_token'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'refresh_token', @sTmp0
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'resource', 'https://mydynamicsdomain.api.crm.dynamics.com'

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT

    EXEC sp_OASetProperty @req, 'HttpVerb', 'POST'
    EXEC sp_OASetProperty @req, 'ContentType', 'application/x-www-form-urlencoded'

    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @http, 'HttpReq', @success OUT, 'https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token', @req, @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @dtExpire
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    -- Load the JSON response.
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    -- Show the JSON response.
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0


    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT 'Response status code: ' + @iTmp0

    -- If the response status code is not 200, then it's an error.
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @dtExpire
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    -- 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.
    EXEC sp_OAMethod @json, 'HasMember', @iTmp0 OUT, 'expires_on'
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAMethod @dtExpire, 'SetFromCurrentSystemTime', @success OUT
        EXEC sp_OAMethod @json, 'IntOf', @iTmp0 OUT, 'expires_in'
        EXEC sp_OAMethod @dtExpire, 'AddSeconds', @success OUT, @iTmp0
        EXEC sp_OAMethod @dtExpire, 'GetAsUnixTimeStr', @sTmp0 OUT, 0
        EXEC sp_OAMethod @json, 'AppendString', @success OUT, 'expires_on', @sTmp0
      END

    -- Save the refreshed access token JSON to a file for future requests.
    DECLARE @fac int
    EXEC @hr = sp_OACreate 'Chilkat.FileAccess', @fac OUT

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @fac, 'WriteEntireTextFile', @success OUT, 'qa_data/tokens/dynamicsCrm.json', @sTmp0, 'utf-8', 0

    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @dtExpire
    EXEC @hr = sp_OADestroy @req
    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @fac


END
GO