Chilkat Online Tools

Objective-C / ForgeRock Identity Cloud Collection / Step 3: Exchange the Authorization Code for an Access Token

Back to Collection Items

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
[req AddParam: @"grant_type" value: @"authorization_code"];

CkoJsonObject *jsonParam2 = [[CkoJsonObject alloc] init];
[req AddParam: @"code" value: [jsonParam2 Emit]];

CkoJsonObject *jsonParam3 = [[CkoJsonObject alloc] init];
[req AddParam: @"client_id" value: [jsonParam3 Emit]];

CkoJsonObject *jsonParam4 = [[CkoJsonObject alloc] init];
[req AddParam: @"client_secret" value: [jsonParam4 Emit]];

CkoJsonObject *jsonParam5 = [[CkoJsonObject alloc] init];
[req AddParam: @"redirect_uri" value: [jsonParam5 Emit]];

CkoJsonObject *jsonParam6 = [[CkoJsonObject alloc] init];
[req AddParam: @"code_verifier" value: [jsonParam6 Emit]];

[req AddHeader: @"Authorization" value: @"Bearer <access_token>"];

CkoHttpResponse *resp = [http PostUrlEncoded: @"https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token" req: req];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

// 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

NSString *access_token = [jResp StringOf: @"access_token"];
NSString *refresh_token = [jResp StringOf: @"refresh_token"];
NSString *scope = [jResp StringOf: @"scope"];
NSString *token_type = [jResp StringOf: @"token_type"];
int expires_in = [[jResp IntOf: @"expires_in"] intValue];

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}"
    }
  ]
}