Powershell / ForgeRock Identity Cloud Collection / Step 3: Exchange the Authorization Code for an Access Token
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$req = New-Object Chilkat.HttpRequest
$req.AddParam("grant_type","authorization_code")
$jsonParam2 = New-Object Chilkat.JsonObject
$req.AddParam("code",$jsonParam2.Emit())
$jsonParam3 = New-Object Chilkat.JsonObject
$req.AddParam("client_id",$jsonParam3.Emit())
$jsonParam4 = New-Object Chilkat.JsonObject
$req.AddParam("client_secret",$jsonParam4.Emit())
$jsonParam5 = New-Object Chilkat.JsonObject
$req.AddParam("redirect_uri",$jsonParam5.Emit())
$jsonParam6 = New-Object Chilkat.JsonObject
$req.AddParam("code_verifier",$jsonParam6.Emit())
$req.AddHeader("Authorization","Bearer <access_token>")
$resp = $http.PostUrlEncoded("https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token",$req)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "access_token": "eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM",
# "refresh_token": "eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw",
# "scope": "share",
# "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}}'
--data-urlencode 'code_verifier={{code_verifier}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token
Postman Collection Item JSON
{
"name": "Step 3: Exchange the Authorization 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\");",
"});",
"",
""
],
"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": "The grant type required for the Authorization Code with PKCE grant.",
"type": "text"
},
{
"key": "code",
"value": "{{authorization_code}}",
"description": "The authentication code from the previous step.",
"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. See the ForgeRock documentation for stronger methods of client authentication.",
"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"
},
{
"key": "code_verifier",
"value": "{{code_verifier}}",
"description": "The generated code verifier. See the \"Pre-request Script\" tab of \"Step 2\" for details.",
"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 authorization 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": "The grant type required for the Authorization Code with PKCE grant.",
"type": "text"
},
{
"key": "code",
"value": "{{authorization_code}}",
"description": "The authentication code from the previous step.",
"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. See the ForgeRock documentation for stronger methods of client authentication.",
"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"
},
{
"key": "code_verifier",
"value": "{{code_verifier}}",
"description": "The generated code verifier.",
"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": "1644"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:14:20 GMT"
}
],
"cookie": [
],
"body": "{\n \"access_token\": \"eyJ0eXAiJ9.eyJzdWIiOiJkZPXXcM\",\n \"refresh_token\": \"eyJ0eXAiOiJKV1QiLC.eyl0VHJXpdhFiWDw\",\n \"scope\": \"share\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"
}
]
}
