PowerShell

Adobe Sign OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to get an Adobe Sign OAuth2 access token from a desktop application or script. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

# To further clarify, see OAuth 2.0 Authorization Flow

$oauth2 = New-Object Chilkat.OAuth2

# The Adobe Sign OAuth2 requires an "https" callback URL.  This means the "http://localhost:<portNumber>/" is not possible.
# For a desktop app, you must provide a script on your web server to redirect to "http://localhost:<portNumber>/"

# See Using Your Web Server as an Intermediary for OAuth2 Redirect to localhost

$oauth2.AppCallbackUrl = "https://yourwebserver.com/OAuth2.php"
$oauth2.ListenPort = 3017

$oauth2.AuthorizationEndpoint = "https://secure.na2.echosign.com/public/oauth"
$oauth2.TokenEndpoint = "https://api.na2.echosign.com/oauth/token"

# Replace these with actual values.
$oauth2.ClientId = "MY_CLIENT_ID"

# This is for Require Proof Key for Code Exchange (PKCE)
# See OAuth2 PKCE Explained
$oauth2.CodeChallenge = $true
$oauth2.CodeChallengeMethod = "S256"

# Indicate the desired access by listing scopes.
$oauth2.Scope = "user_read agreement_read workflow_read"

# Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2.StartAuth()
if ($oauth2.LastMethodSuccess -ne $true) {
    $($oauth2.LastErrorText)
    exit
}

$("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 = $oauth2.LaunchBrowser($url)
if ($success -eq $false) {
    $($oauth2.LastErrorText)
    exit
}

# Wait for the user to approve or deny authorization in the browser.
$numMsWaited = 0
while (($numMsWaited -lt 90000) -and ($oauth2.AuthFlowState -lt 3)) {
    $oauth2.SleepMs(100)
    $numMsWaited = $numMsWaited + 100
}

# 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 ($oauth2.AuthFlowState -lt 3) {
    $oauth2.Cancel()
    $("No response from the browser!")
    exit
}

# 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 ($oauth2.AuthFlowState -eq 5) {
    $("OAuth2 failed to complete.")
    $($oauth2.FailureInfo)
    exit
}

if ($oauth2.AuthFlowState -eq 4) {
    $("OAuth2 authorization was denied.")
    $($oauth2.AccessTokenResponse)
    exit
}

if ($oauth2.AuthFlowState -ne 3) {
    $("Unexpected AuthFlowState:" + $oauth2.AuthFlowState)
    exit
}

# Save the full JSON access token response to a file.
$sbJson = New-Object Chilkat.StringBuilder
$sbJson.Append($oauth2.AccessTokenResponse)
$sbJson.WriteFile("qa_data/tokens/adobe-sign-access-token.json","utf-8",$false)

# The full JSON received looks like this:
# {
#   "access_token": "3AAABL ... YCpUu",
#   "refresh_token": "3AAABL ... tpDs0*",
#   "token_type": "Bearer",
#   "expires_in": 3600
# }

$("OAuth2 authorization granted!")
$("Access Token = " + $oauth2.AccessToken)