PureBasic Requires Chilkat v10.1.2+

SharePoint Rest API using OAuth

See more OAuth2 Examples

Demonstrates how to get an OAuth2 access token for the SharePoint REST API. PureBasic

IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  To further clarify, see OAuth 2.0 Authorization Flow

    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  The ListenPort should match the port in your localhost Reply URL of your Azure AD app.
    ;  Your Reply URL must be exactly "http://localhost:LISTEN_PORT/"
    ;     * Do not use "https"
    ;     * Make sure the ending "/" is included.
    ;     * You may choose any port number that doesn't collide with anything else.
    CkOAuth2::setCkListenPort(oauth2, 3017)

    CkOAuth2::setCkAuthorizationEndpoint(oauth2, "https://login.microsoftonline.com/TENANT_ID/oauth2/authorize")
    CkOAuth2::setCkTokenEndpoint(oauth2, "https://login.windows.net/TENANT_ID/oauth2/token?api-version=1.0")

    ;  Replace these with actual values.
    ;  Use the application ID
    CkOAuth2::setCkClientId(oauth2, "CLIENT_ID")
    ;  Use the password
    CkOAuth2::setCkClientSecret(oauth2, "CLIENT_SECRET")

    CkOAuth2::setCkCodeChallenge(oauth2, 0)

    CkOAuth2::setCkScope(oauth2, "openid")
    CkOAuth2::setCkResource(oauth2, "https://graph.microsoft.com/")

    CkOAuth2::setCkIncludeNonce(oauth2, 1)
    CkOAuth2::setCkResponseMode(oauth2, "form_post")
    CkOAuth2::setCkResponseType(oauth2, "id_token+code")

    ;  Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
    url.s = CkOAuth2::ckStartAuth(oauth2)
    If CkOAuth2::ckLastMethodSuccess(oauth2) = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "url = " + url

    ;  Launch the default browser on the system and navigate to the url.
    ;  The LaunchBrowser method was added in Chilkat v10.1.2.
    success = CkOAuth2::ckLaunchBrowser(oauth2,url)
    If success = 0
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    ;  Wait for the user to approve or deny authorization in the browser.
    numMsWaited.i = 0
    While (numMsWaited < 90000) AND (CkOAuth2::ckAuthFlowState(oauth2) < 3)
        CkOAuth2::ckSleepMs(oauth2,100)
        numMsWaited = numMsWaited + 100
    Wend

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

    If CkOAuth2::ckAuthFlowState(oauth2) < 3
        CkOAuth2::ckCancel(oauth2)
        Debug "No response from the browser!"
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

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

    If CkOAuth2::ckAuthFlowState(oauth2) = 5
        Debug "OAuth2 failed to complete."
        Debug CkOAuth2::ckFailureInfo(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) = 4
        Debug "OAuth2 authorization was denied."
        Debug CkOAuth2::ckAccessTokenResponse(oauth2)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    If CkOAuth2::ckAuthFlowState(oauth2) <> 3
        Debug "Unexpected AuthFlowState:" + Str(CkOAuth2::ckAuthFlowState(oauth2))
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "OAuth2 authorization granted!"
    Debug "Access Token = " + CkOAuth2::ckAccessToken(oauth2)


    CkOAuth2::ckDispose(oauth2)


    ProcedureReturn
EndProcedure