(PowerShell) Twitter API v2 - Get OAuth2 Access Token

See more Twitter API v2 Examples

Demonstrates how to get a Twitter API v2 OAuth2 access token from a desktop application or script.

For more information, see https://developer.twitter.com/en/docs/authentication/oauth-2-0/user-access-token

Chilkat .NET Downloads Chilkat .NET Assemblies

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

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

$oauth2 = New-Object Chilkat.OAuth2

# This should be the port in the localhost callback URI for your App (defined in the Twitter Developer Portal)
# The Callback URI / Redirect URL should be "http://localhost:3017/" if the port number is 3017.
$oauth2.ListenPort = 3017

$oauth2.AuthorizationEndpoint = "https://twitter.com/i/oauth2/authorize"
$oauth2.TokenEndpoint = "https://api.twitter.com/2/oauth2/token"

# Replace these with actual values.
$oauth2.ClientId = "CLIENT_ID"
$oauth2.ClientSecret = "CLIENT_SECRET"

$oauth2.Scope = "tweet.read users.read follows.read follows.write"

$oauth2.AddAuthQueryParam("offline.access","")
$oauth2.AddAuthQueryParam("state","state")
$oauth2.CodeChallenge = $true
$oauth2.CodeChallengeMethod = "plain"
$oauth2.UseBasicAuth = $true

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

$($url)

# At this point, your application should load the URL in a browser.
# For example, 
# in C#: System.Diagnostics.Process.Start(url);
# in Java: Desktop.getDesktop().browse(new URI(url));
# in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
#              wsh.Run url
# in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
# in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
# The Microsoft account owner would interactively accept or deny the authorization request.

# Add the code to load the url in a web browser here...
# Add the code to load the url in a web browser here...
# Add the code to load the url in a web browser here...

# Now wait for the authorization.
# We'll wait for a max of 60 seconds.
$numMsWaited = 0
while (($numMsWaited -lt 60000) -and ($oauth2.AuthFlowState -lt 3)) {
    $oauth2.SleepMs(100)
    $numMsWaited = $numMsWaited + 100
}

# If there was no response from the browser within 60 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 -lt 3) {
    $oauth2.Cancel()
    $("No response from the browser!")
    exit
}

# 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 -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
}

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

# Get the full JSON response:
$json = New-Object Chilkat.JsonObject
$json.Load($oauth2.AccessTokenResponse)
$json.EmitCompact = $false

# The JSON response looks like this:

# {
#   "token_type": "bearer",
#   "expires_in": 7200,
#   "access_token": "NnAfRUxCVWhLNDB3MFRvd25yQlNnelRZY1F1WkFlQqVfNXYwOEVobVNqR0VfOjf2NTg4NDk0MjMxnzE6MTowOmF2OjE",
#   "scope": "users.read follows.read tweet.read follows.write"
# }

$($json.Emit())

# Save the JSON to a file for future requests.
$fac = New-Object Chilkat.FileAccess
$fac.WriteEntireTextFile("qa_data/tokens/twitter_v2_oauth2.json",$json.Emit(),"utf-8",$false)