DataFlex

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?

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJsonToken
    Handle hoOauth2
    Variant vSbJson
    Handle hoSbJson
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/hotmail.json" To iSuccess
    If (iSuccess <> True) Begin
        Showln "Failed to load office365.json"
        Procedure_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"
    // }

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

    // See Microsoft OAuth2 Authorization Endpoint
    Set ComTokenEndpoint Of hoOauth2 To "https://login.microsoftonline.com/common/oauth2/v2.0/token"

    // Replace this with your actual App Registration's Application (client) ID.
    Set ComClientId Of hoOauth2 To "CLIENT_ID"

    // Get the "refresh_token"
    Get ComStringOf Of hoJsonToken "refresh_token" To sTemp1
    Set ComRefreshToken Of hoOauth2 To sTemp1

    // Send the HTTP POST to refresh the access token..
    Get ComRefreshAccessToken Of hoOauth2 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComLastErrorText Of hoOauth2 To sTemp1
    Showln sTemp1

    Get ComAccessToken Of hoOauth2 To sTemp1
    Showln "New access token: " sTemp1
    Get ComRefreshToken Of hoOauth2 To sTemp1
    Showln "New refresh token: " sTemp1

    // Update the JSON with the new tokens.
    Get ComAccessToken Of hoOauth2 To sTemp1
    Get ComUpdateString Of hoJsonToken "access_token" sTemp1 To iSuccess
    Get ComRefreshToken Of hoOauth2 To sTemp1
    Get ComUpdateString Of hoJsonToken "refresh_token" sTemp1 To iSuccess

    // Save the new JSON access token response to a file.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJson
    If (Not(IsComObjectCreated(hoSbJson))) Begin
        Send CreateComObject of hoSbJson
    End
    Set ComEmitCompact Of hoJsonToken To False
    Get pvComObject of hoSbJson to vSbJson
    Get ComEmitSb Of hoJsonToken vSbJson To iSuccess
    Get ComWriteFile Of hoSbJson "qa_data/tokens/hotmail.json" "utf-8" False To iSuccess

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


End_Procedure