SQL Server

Refresh Expiring OAuth2 Access Token for Azure Registered App

See more OAuth2 Examples

Shows how to renew an Azure App's access token using the refresh token when it's near expiration. 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

    -- We previously obtained an access token and saved the JSON to a file using this example:
    -- Get OAuth2 Access Token for Azure Registered App

    -- 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/_myAzureApp.json'
    IF @success <> 1
      BEGIN

        PRINT 'Failed to load the access token.'
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- The contents of the JSON look like this:
    -- {
    --   "token_type": "Bearer",
    --   "scope": "User.Read Mail.ReadWrite Mail.Send",
    --   "expires_in": 3600,
    --   "ext_expires_in": 0,
    --   "access_token": "EwBAA8l6B...",
    --   "refresh_token": "MCRMdbe6Cd...",
    --   "id_token": "eyJ0eXAiOiJ...",
    --   "expires_on": "1494112119"
    -- }

    -- 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.
    EXEC sp_OAMethod @dtExpire, 'ExpiresWithin', @iTmp0 OUT, 10, 'minutes'
    IF @iTmp0 <> 1
      BEGIN

        PRINT 'No need to refresh, the access token won''t expire within the next 10 minutes.'
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @dtExpire
        RETURN
      END

    -- OK, we need to refresh the access token..
    DECLARE @oauth2 int
    EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT

    -- Note: The endpoint depends on the Azure App Registration.
    -- See How to Choose the Correct Endpoints for your Azure App Registration
    EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://login.microsoftonline.com/common/oauth2/v2.0/token'

    -- Use your client ID.
    EXEC sp_OASetProperty @oauth2, 'ClientId', 'CLIENT_ID'

    -- Get the existing refresh token.
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'refresh_token'
    EXEC sp_OASetProperty @oauth2, 'RefreshToken', @sTmp0

    -- Send the HTTP POST to refresh the access token.
    EXEC sp_OAMethod @oauth2, 'RefreshAccessToken', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @dtExpire
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END


    PRINT 'OAuth2 authorization granted!'

    EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
    PRINT 'Access Token = ' + @sTmp0

    -- Get the full JSON response:
    EXEC sp_OAGetProperty @oauth2, 'AccessTokenResponse', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

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

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- Save the new 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/_myAzureApp.json', @sTmp0, 'utf-8', 0

    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @dtExpire
    EXEC @hr = sp_OADestroy @oauth2
    EXEC @hr = sp_OADestroy @fac


END
GO