B4X

Docusign Request Impersonation Consent

See more DocuSign Examples

Demonstrates how to obtain impersonation consent from a Docusign individual user. This is one way of getting consent prior to using the JWT (JSON Web Token) grant flow to obtain access tokens. See the Docusign documentation for Obtaining Consent and JSON Web Token (JWT) Grant for more information.

Important: This example requires that you add a line of code (or a few lines of code) to launch a web browser that navigates to the URL returned by the StartAuth method.

B4X

Dim success As Boolean = False

'  This example requires the Chilkat API to have been previously unlocked.
'  See Global Unlock Sample for sample code.

Dim oauth2 As ChilkatOAuth2
oauth2.Initialize("oauth2")

'  This should be the port in the localhost Redirect URI for your app defined in the Docusign developer portal.  
'  The Redirect URI would look like "http://localhost:3017/" if the port number is 3017.
oauth2.ListenPort = 3017

'  For the developer sandbox environment, the authorization endpoint is https://account-d.docusign.com/oauth/auth
'  For the production platform, the authorization endpoint is https://account.docusign.com/oauth/auth
oauth2.AuthorizationEndpoint = "https://account-d.docusign.com/oauth/auth"
oauth2.TokenEndpoint = "https://account-d.docusign.com/oauth/token"

'  Replace these with actual values.
'  The client ID is also known as the "integration key" in Docusign.
oauth2.ClientId = "MY_DOCUSIGN_CLIENT_ID"
'  This is your secret key for the authorization code grant.
oauth2.ClientSecret = "MY_DOCUSIGN_CLIENT_SECRET"

oauth2.Scope = "signature impersonation"

'  Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
Dim url As String = oauth2.StartAuth
If oauth2.LastMethodSuccess = False Then
    Log(oauth2.LastErrorText)
    Return
End If


'  Launch the system's default browser navigated to the URL.
success = oauth2.LaunchBrowser(url)
If success = False Then
    Log(oauth2.LastErrorText)
    Return
End If


'  Now wait for the authorization.
'  We'll wait for a max of 30 seconds.
Dim numMsWaited As Int = 0
Do While (numMsWaited < 30000) And (oauth2.AuthFlowState < 3)
    oauth2.SleepMs(100)
    numMsWaited = numMsWaited + 100
Loop

'  If there was no response from the browser within 30 seconds, then 
'  the AuthFlowState will be equal to 1 or 2.
'  1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
'  2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
'  In that case, cancel the background task started in the call to StartAuth.
If oauth2.AuthFlowState < 3 Then
    oauth2.Cancel
    Log("No response from the browser!")
    Return
End If


'  Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
'  The possible AuthFlowState values are:
'  3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
'  4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
'  5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
If oauth2.AuthFlowState = 5 Then
    Log("OAuth2 failed to complete.")
    Log(oauth2.FailureInfo)
    Return
End If


If oauth2.AuthFlowState = 4 Then
    Log("OAuth2 authorization was denied.")
    Log(oauth2.AccessTokenResponse)
    Return
End If


If oauth2.AuthFlowState <> 3 Then
    Log("Unexpected AuthFlowState:" & oauth2.AuthFlowState)
    Return
End If


Log("OAuth2 authorization granted!")
Log("Access Token = " & oauth2.AccessToken)

'  Get the full JSON response:
Dim json As ChilkatJsonObject
json.Initialize
json.Load(oauth2.AccessTokenResponse)
json.EmitCompact = False
Log(json.Emit)

'  The JSON response looks like this:

'  Note: It doesn't seem like the access_token obtained here is actually used.
'  My guess is that the act of getting this access token persists the knowledge that the
'  DocuSign user account has granted access to the application.  The application only needs
'  to send a valid JWT to prove it's identity and get an access token (JSON Web Token Grant (JWT))
'  {
'    "access_token": "eyJ0eXA....YQyig",
'    "token_type": "Bearer",
'    "refresh_token": "eyJ0eXA....auE3eHKg",
'    "expires_in": 28800
'  }

'  Save the JSON to a file for future requests.
Dim fac As ChilkatFileAccess
fac.Initialize
fac.WriteEntireTextFile("qa_data/tokens/docusignImpersonation.json", json.Emit, "utf-8", False)