Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.HttpRequest')
$req = new COM("Chilkat.HttpRequest");
$req->AddParam('grant_type','authorization_code');
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam2 = new COM("Chilkat.JsonObject");
$req->AddParam('code',$jsonParam2->emit());
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam3 = new COM("Chilkat.JsonObject");
$req->AddParam('client_id',$jsonParam3->emit());
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam4 = new COM("Chilkat.JsonObject");
$req->AddParam('client_secret',$jsonParam4->emit());
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonParam5 = new COM("Chilkat.JsonObject");
$req->AddParam('redirect_uri',$jsonParam5->emit());
$req->AddHeader('Authorization','Bearer <access_token>');
// resp is a Chilkat.HttpResponse
$resp = $http->PostUrlEncoded('https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token',$req);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "access_token": "eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM",
// "refresh_token": "eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw",
// "scope": "edit",
// "token_type": "Bearer",
// "expires_in": 3599
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$access_token = $jResp->stringOf('access_token');
$refresh_token = $jResp->stringOf('refresh_token');
$scope = $jResp->stringOf('scope');
$token_type = $jResp->stringOf('token_type');
$expires_in = $jResp->IntOf('expires_in');
?>
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/x-www-form-urlencoded"
--data-urlencode 'grant_type=authorization_code'
--data-urlencode 'code={{authorization_code}}'
--data-urlencode 'client_id={{postmanConfidentialClientId}}'
--data-urlencode 'client_secret={{postmanClientSecret}}'
--data-urlencode 'redirect_uri={{redirect_uri}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token
Postman Collection Item JSON
{
"name": "Step 3: Exchange the Authentication Code for an Access Token",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"",
"if(jsonData.access_token && jsonData.access_token != \"\")",
"{",
" pm.globals.set(\"access_token\", jsonData.access_token);",
"}",
"",
"if(jsonData.refresh_token && jsonData.refresh_token != \"\")",
"{",
" pm.globals.set(\"refresh_token\", jsonData.refresh_token);",
"}",
"",
"// Tests",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains access_token\", function () {",
" pm.expect(jsonData.access_token).to.be.a(\"string\");",
"});",
"",
"pm.test(\"Response contains refresh_token\", function () {",
" pm.expect(jsonData.refresh_token).to.be.a(\"string\");",
"});",
"",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "grant_type",
"value": "authorization_code",
"description": "Grant types this client will support and use.",
"type": "text"
},
{
"key": "code",
"value": "{{authorization_code}}",
"description": "The authentication code.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanConfidentialClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "client_secret",
"value": "{{postmanClientSecret}}",
"description": "The secret of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "redirect_uri",
"value": "{{redirect_uri}}",
"description": "The complete URI to which client redirects the user if the request is successful.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/access_token",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"access_token"
]
},
"description": "Authenticate with the authorization server using the details of the confidential client and the authentication code recieved in the previous call.\n"
},
"response": [
{
"name": "Example",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "grant_type",
"value": "authorization_code",
"description": "Grant types this client will support and use.",
"type": "text"
},
{
"key": "code",
"value": "{{authorization_code}}",
"description": "The authentication code.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanConfidentialClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "client_secret",
"value": "{{postmanClientSecret}}",
"description": "The secret of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "redirect_uri",
"value": "{{redirect_uri}}",
"description": "The complete URI to which client redirects the user if the request is successful.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/access_token",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"access_token"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Cache-Control",
"value": "no-store"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "1641"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:21:39 GMT"
}
],
"cookie": [
],
"body": "{\n \"access_token\": \"eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw\",\n \"scope\": \"edit\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"
}
]
}
