PowerBuilder Requires Chilkat v10.1.2+

Salesforce OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to get a Salesforce OAuth2 access token from a desktop application or script. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Oauth2
string ls_Url
integer li_NumMsWaited
oleobject loo_SbJson

li_Success = 0

//  To further clarify, see OAuth 2.0 Authorization Flow

loo_Oauth2 = create oleobject
li_rc = loo_Oauth2.ConnectToNewObject("Chilkat.OAuth2")
if li_rc < 0 then
    destroy loo_Oauth2
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  This should be the port in the localhost callback URL for your connected app.  
//  The callback URL would look like "http://localhost:3017/" if the port number is 3017.
loo_Oauth2.ListenPort = 3017

loo_Oauth2.AuthorizationEndpoint = "https://login.salesforce.com/services/oauth2/authorize"
loo_Oauth2.TokenEndpoint = "https://login.salesforce.com/services/oauth2/token"

//  Replace this with your actual client ID (Consumer Key)
loo_Oauth2.ClientId = "CLIENT_ID"

//  We don't have to include the client secret.
//  See the screenshot of our Connected App below..

//  This is for Require Proof Key for Code Exchange (PKCE)
//  See OAuth2 PKCE Explained
loo_Oauth2.CodeChallenge = 1
loo_Oauth2.CodeChallengeMethod = "S256"

//  To force the OAuth consent screen to reappear (even if previously granted), use:
loo_Oauth2.AddAuthQueryParam("prompt","consent")

//  Begin the OAuth2 authorization flow.  This returns a URL that should be loaded in a browser.
ls_Url = loo_Oauth2.StartAuth()
if loo_Oauth2.LastMethodSuccess <> 1 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

//  Launch the default browser on the system and navigate to the url.
//  The LaunchBrowser method was added in Chilkat v10.1.2.
li_Success = loo_Oauth2.LaunchBrowser(ls_Url)
if li_Success = 0 then
    Write-Debug loo_Oauth2.LastErrorText
    destroy loo_Oauth2
    return
end if

//  Wait for the user to approve or deny authorization in the browser.
li_NumMsWaited = 0
do while (li_NumMsWaited < 90000) AND (loo_Oauth2.AuthFlowState < 3)
    loo_Oauth2.SleepMs(100)
    li_NumMsWaited = li_NumMsWaited + 100
loop

//  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 loo_Oauth2.AuthFlowState < 3 then
    loo_Oauth2.Cancel()
    Write-Debug "No response from the browser!"
    destroy loo_Oauth2
    return
end if

//  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 loo_Oauth2.AuthFlowState = 5 then
    Write-Debug "OAuth2 failed to complete."
    Write-Debug loo_Oauth2.FailureInfo
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState = 4 then
    Write-Debug "OAuth2 authorization was denied."
    Write-Debug loo_Oauth2.AccessTokenResponse
    destroy loo_Oauth2
    return
end if

if loo_Oauth2.AuthFlowState <> 3 then
    Write-Debug "Unexpected AuthFlowState:" + string(loo_Oauth2.AuthFlowState)
    destroy loo_Oauth2
    return
end if

Write-Debug "OAuth2 authorization granted!"
Write-Debug "Access Token = " + loo_Oauth2.AccessToken

//  Save the full JSON access token response to a file.
loo_SbJson = create oleobject
li_rc = loo_SbJson.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbJson.Append(loo_Oauth2.AccessTokenResponse)
loo_SbJson.WriteFile("qa_data/tokens/_salesforce.json","utf-8",0)

//  The saved JSON response looks like this:

//  {
//    "access_token": "00D41000....uLZBpT6",
//    "refresh_token": "5Aep....25xdGgkrV",
//    "signature": "cjTbSc5DvcKpaMoRTzuQTJLb1tcMw8LEO01flq4aMD4=",
//    "scope": "refresh_token id",
//    "instance_url": "https://d41000000f8a0eak-dev-ed.my.salesforce.com",
//    "id": "https://login.salesforce.com/id/00D41000000F8A0EAK/005410000....xAAE",
//    "token_type": "Bearer",
//    "issued_at": "1738348388166"
//  }

//  --------------------------------------------------------------------------
//  Here's a screenshot of a Salesforce Connected App 
//  with the correct Callback URL for this example,
//  and also selects "Require Proof Key for Code Exchange (PKCE)"
//  and does not requires the secret for the authorization or refresh flow,
//  and also allows for the Client Credentials flow.
//  


destroy loo_Oauth2
destroy loo_SbJson