SQL Server Requires Chilkat v10.1.2+
SQL Server
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 SQL Server Downloads
-- 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
DECLARE @iTmp1 int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- To further clarify, see OAuth 2.0 Authorization Flow
DECLARE @oauth2 int
EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
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.
EXEC sp_OASetProperty @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
EXEC sp_OASetProperty @oauth2, 'AuthorizationEndpoint', 'https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize'
EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token'
-- Replace these with actual values.
EXEC sp_OASetProperty @oauth2, 'ClientId', 'DYNAMICS-CRM-CLIENT-ID'
EXEC sp_OASetProperty @oauth2, 'ClientSecret', 'DYNAMICS-CRM-SECRET-KEY'
EXEC sp_OASetProperty @oauth2, 'Resource', 'https://mydynamicsdomain.api.crm.dynamics.com'
EXEC sp_OASetProperty @oauth2, 'RedirectAllowHtml', '<html><body><p>Thank you for granting access.</p></bod></html>'
EXEC sp_OASetProperty @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.
DECLARE @url nvarchar(4000)
EXEC sp_OAMethod @oauth2, 'StartAuth', @url OUT
EXEC sp_OAGetProperty @oauth2, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 <> 1
BEGIN
EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
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.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
DECLARE @sbPreCheck int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPreCheck OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, @url, @sbPreCheck
EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
EXEC sp_OAMethod @sbPreCheck, 'StartsWith', @iTmp1 OUT, '{', 1
IF (@iTmp0 <> 200) or (@iTmp1 <> 1)
BEGIN
PRINT 'JSON Error Response:'
EXEC sp_OAMethod @sbPreCheck, 'GetAsString', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
RETURN
END
-- If the HTTP request itself failed, then examine the error.
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
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.
EXEC sp_OAMethod @oauth2, 'LaunchBrowser', @success OUT, @url
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
RETURN
END
-- Wait for the user to approve or deny authorization in the browser.
DECLARE @numMsWaited int
SELECT @numMsWaited = 0
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
WHILE (@numMsWaited < 90000) and (@iTmp0 < 3)
BEGIN
EXEC sp_OAMethod @oauth2, 'SleepMs', NULL, 100
SELECT @numMsWaited = @numMsWaited + 100
END
-- 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.
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 < 3
BEGIN
EXEC sp_OAMethod @oauth2, 'Cancel', @success OUT
PRINT 'No response from the browser!'
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
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.
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 = 5
BEGIN
PRINT 'OAuth2 failed to complete.'
EXEC sp_OAGetProperty @oauth2, 'FailureInfo', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
RETURN
END
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 = 4
BEGIN
PRINT 'OAuth2 authorization was denied.'
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
RETURN
END
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
IF @iTmp0 <> 3
BEGIN
EXEC sp_OAGetProperty @oauth2, 'AuthFlowState', @iTmp0 OUT
PRINT 'Unexpected AuthFlowState:' + @iTmp0
EXEC @hr = sp_OADestroy @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
RETURN
END
PRINT 'OAuth2 authorization granted!'
EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
PRINT 'Access Token = ' + @sTmp0
-- Get the full JSON response:
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
EXEC sp_OASetProperty @json, 'EmitCompact', 0
-- 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.
EXEC sp_OAMethod @json, 'HasMember', @iTmp0 OUT, 'expires_on'
IF @iTmp0 <> 1
BEGIN
DECLARE @dtExpire int
EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @dtExpire OUT
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
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- Save the 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 @oauth2
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbPreCheck
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @dtExpire
EXEC @hr = sp_OADestroy @fac
END
GO