SQL Server

Hotmail Refresh Access Token (also for Live.com, Outlook.com)

See more OAuth2 Examples

An OAuth2 access token is typically valid for 1 hour. Interaction with the Hotmail account owner via a browser is only needed for getting the initial access token. Once you have it, it can be continually refreshed without user interaction for a long time.

See: How Long can an OAuth2 Access Token be Refreshed?

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

    -- It is assumed we previously obtained an OAuth2 access token.

    -- Note: Refreshing an access token does not require user-interaction.  
    -- Only the act of getting the initial access token requires interactive authorization from the Hotmail account owner 
    -- (i.e. a browser is displayed and the Hotmail account owner authorizes access by the app).

    -- Once you have the initial access token, it can be refreshed for a long time.
    -- A typical strategy is to write your application to automatically refresh the access token 
    -- when authentication fails, and then retry the operation with the new access token.

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

    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/hotmail.json'
    IF @success <> 1
      BEGIN

        PRINT 'Failed to load office365.json'
        EXEC @hr = sp_OADestroy @jsonToken
        RETURN
      END

    -- The access token JSON looks like this:

    -- {
    --   "token_type": "Bearer",
    --   "scope": "https://outlook.office.com/SMTP.Send https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/POP.AccessAsUser.All",
    --   "expires_in": 3600,
    --   "ext_expires_in": 3600,
    --   "access_token": "EwBoA+ ... 7pOYcWr5pFwQgI=",
    --   "refresh_token": "M.C546_BL2.0.U.-CkW ... g5CKSlDBQ$$",
    --   "id_token": "eyJ0e ... 2iiu5iqBK9n7s3A"
    -- }

    DECLARE @oauth2 int
    EXEC @hr = sp_OACreate 'Chilkat.OAuth2', @oauth2 OUT

    -- See Microsoft OAuth2 Authorization Endpoint
    EXEC sp_OASetProperty @oauth2, 'TokenEndpoint', 'https://login.microsoftonline.com/common/oauth2/v2.0/token'

    -- Replace this with your actual App Registration's Application (client) ID.
    EXEC sp_OASetProperty @oauth2, 'ClientId', 'CLIENT_ID'

    -- Get the "refresh_token"
    EXEC sp_OAMethod @jsonToken, '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 <> 1
      BEGIN
        EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @oauth2
        RETURN
      END
    EXEC sp_OAGetProperty @oauth2, 'LastErrorText', @sTmp0 OUT
    PRINT @sTmp0


    EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
    PRINT 'New access token: ' + @sTmp0

    EXEC sp_OAGetProperty @oauth2, 'RefreshToken', @sTmp0 OUT
    PRINT 'New refresh token: ' + @sTmp0

    -- Update the JSON with the new tokens.
    EXEC sp_OAGetProperty @oauth2, 'AccessToken', @sTmp0 OUT
    EXEC sp_OAMethod @jsonToken, 'UpdateString', @success OUT, 'access_token', @sTmp0
    EXEC sp_OAGetProperty @oauth2, 'RefreshToken', @sTmp0 OUT
    EXEC sp_OAMethod @jsonToken, 'UpdateString', @success OUT, 'refresh_token', @sTmp0

    -- Save the new JSON access token response to a file.
    DECLARE @sbJson int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJson OUT

    EXEC sp_OASetProperty @jsonToken, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonToken, 'EmitSb', @success OUT, @sbJson
    EXEC sp_OAMethod @sbJson, 'WriteFile', @success OUT, 'qa_data/tokens/hotmail.json', 'utf-8', 0


    PRINT 'OAuth2 authorization granted!'

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

    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @oauth2
    EXEC @hr = sp_OADestroy @sbJson


END
GO