PHP Extension

Authorization Code Flow with PKCE for Native Apps

See more Okta OAuth/OIDC Examples

Demonstrates the authorization code flow with Proof Key for Code Exchange (PKCE) for native apps. In Okta, your app should be defined as shown: PHP Extension

<?php

include("chilkat.php");

$success = false;

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

$oauth2 = new CkOAuth2();

// This should be the port in the Login redirect URI for your app.  
// Your app's Login redirect URI should be "http://localhost:3017/" if the port number is 3017.
$oauth2->put_ListenPort(3017);

$oauth2->put_AuthorizationEndpoint('https://{yourOktaDomain}/oauth2/default/v1/authorize');
$oauth2->put_TokenEndpoint('https://{yourOktaDomain}/oauth2/default/v1/token');

// Replace these with actual values.
$oauth2->put_ClientId('OKTA_CLIENT_ID');
$oauth2->put_ClientSecret('OKTA_CLIENT_SECRET');

$oauth2->put_CodeChallenge(true);
$oauth2->put_IncludeNonce(true);

// Make sure to include "offline_access" to get a refresh token included in the final JSON response.
// Add any additional needed scopes separated by space chars.
$oauth2->put_Scope('openid offline_access');

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
$url = $oauth2->startAuth();
if ($oauth2->get_LastMethodSuccess() == false) {
    print $oauth2->lastErrorText() . "\n";
    exit;
}

print 'URL to load in browser: ' . $url . "\n";

// Launch the system's default browser navigated to the URL.
$success = $oauth2->LaunchBrowser($url);
if ($success == false) {
    print $oauth2->lastErrorText() . "\n";
    exit;
}

// Now wait for the authorization.
// We'll wait for a max of 60 seconds.
$numMsWaited = 0;
while (($numMsWaited < 60000) and ($oauth2->get_AuthFlowState() < 3)) {
    $oauth2->SleepMs(100);
    $numMsWaited = $numMsWaited + 100;
}

// 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->get_AuthFlowState() < 3) {
    $oauth2->Cancel();
    print 'No response from the browser!' . "\n";
    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->get_AuthFlowState() == 5) {
    print 'OAuth2 failed to complete.' . "\n";
    print $oauth2->failureInfo() . "\n";
    exit;
}

if ($oauth2->get_AuthFlowState() == 4) {
    print 'OAuth2 authorization was denied.' . "\n";
    print $oauth2->accessTokenResponse() . "\n";
    exit;
}

if ($oauth2->get_AuthFlowState() != 3) {
    print 'Unexpected AuthFlowState:' . $oauth2->get_AuthFlowState() . "\n";
    exit;
}

print 'OAuth2 authorization granted!' . "\n";
print 'Access Token = ' . $oauth2->accessToken() . "\n";

// Get the full JSON response:
$json = new CkJsonObject();
$json->Load($oauth2->accessTokenResponse());
$json->put_EmitCompact(false);
print $json->emit() . "\n";

// The JSON response looks like this:

// {
//   "access_token": "eyJraWQi ... Kn4IiEfOw",
//   "token_type": "Bearer",
//   "expires_in": 3600,
//   "scope": "offline_access openid",
//   "refresh_token": "0jCqotuuUegdjNzB9uuSsfGM2Cu5HnCHUxoJ0yhZ4rs",
//   "id_token": "eyJraWQiO ... 09WGEq3dTRmQF86PzJg"
// }

// Save the JSON to a file for future requests.
$fac = new CkFileAccess();
$fac->WriteEntireTextFile('qa_data/tokens/okta.json',$json->emit(),'utf-8',false);

?>