Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept-API-Version","resource=2.1")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"X-OpenAM-Username","{{postmanDemoUsername}}")
CkHttp::ckSetRequestHeader(http,"X-OpenAM-Password","{{postmanDemoPassword}}")
resp.i = CkHttp::ckQuickRequest(http,"POST","https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=PasswordGrant")
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "tokenId": "oamkww1D53KfOLxi_W3ycun7CHU.*AAJTSQACMDEAAlNLABxRdmtuMTlwYWZrYzY0V1RXQUpnbzhUL0FRT2s9AAR0eXBlAANDVFMAAlMxAAA.*",
; "successUrl": "/openam/console",
; "realm": "/"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
tokenId.s = CkJsonObject::ckStringOf(jResp,"tokenId")
successUrl.s = CkJsonObject::ckStringOf(jResp,"successUrl")
realm.s = CkJsonObject::ckStringOf(jResp,"realm")
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "X-OpenAM-Username: {{postmanDemoUsername}}"
-H "X-OpenAM-Password: {{postmanDemoPassword}}"
-H "Content-Type: application/json"
-H "Accept-API-Version: resource=2.1"
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=PasswordGrant
Postman Collection Item JSON
{
"name": "Step 1: Obtain an SSO Token as a Demo User",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const jsonData = JSON.parse(responseBody);",
"",
"if(jsonData.tokenId && jsonData.tokenId != \"\"){",
" pm.globals.set(\"demoSSOToken\", jsonData.tokenId);",
"}",
"",
"// Tests",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains tokenId\", function () {",
" pm.expect(jsonData.tokenId).to.be.a(\"string\");",
"});",
""
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableCookies": false,
"followOriginalHttpMethod": true,
"removeRefererHeaderOnRedirect": true
},
"request": {
"method": "POST",
"header": [
{
"description": "Username for the demo user.",
"key": "X-OpenAM-Username",
"value": "{{postmanDemoUsername}}"
},
{
"description": "Password for the demo user.",
"key": "X-OpenAM-Password",
"value": "{{postmanDemoPassword}}"
},
{
"description": "The media type of the resource.",
"key": "Content-Type",
"value": "application/json"
},
{
"description": "This collection documents version 2.1 of the authentication resource.",
"key": "Accept-API-Version",
"value": "resource=2.1"
}
],
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?authIndexType=service&authIndexValue=PasswordGrant",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
],
"query": [
{
"key": "authIndexType",
"value": "service"
},
{
"key": "authIndexValue",
"value": "PasswordGrant"
}
]
},
"description": "Log in to the authorization server using the credentials of the demo user.\n\nNote: delete your cookies before using this call.\n\n"
},
"response": [
{
"name": "Example",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Username for the demo user.",
"key": "X-OpenAM-Username",
"value": "{{postmanDemoUsername}}"
},
{
"description": "Password for the demo user.",
"key": "X-OpenAM-Password",
"value": "{{postmanDemoPassword}}"
},
{
"description": "The media type of the resource.",
"key": "Content-Type",
"value": "application/json"
},
{
"description": "This collection documents version 2.1 of the authentication resource.",
"key": "Accept-API-Version",
"value": "resource=2.1"
}
],
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
]
}
},
"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": "private"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, must-revalidate"
},
{
"key": "Set-Cookie",
"value": "amlbcookie=01; Path=/; Domain=example.com; HttpOnly"
},
{
"key": "Set-Cookie",
"value": "iPlanetDirectoryPro=sOpI1RvbCgvlQk.*AAJTSQACMDEA.*; Path=/; Domain=example.com; HttpOnly"
},
{
"key": "Content-API-Version",
"value": "resource=2.1"
},
{
"key": "Expires",
"value": "0"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Content-Length",
"value": "167"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:17:34 GMT"
}
],
"cookie": [
],
"body": "{\n \"tokenId\": \"oamkww1D53KfOLxi_W3ycun7CHU.*AAJTSQACMDEAAlNLABxRdmtuMTlwYWZrYzY0V1RXQUpnbzhUL0FRT2s9AAR0eXBlAANDVFMAAlMxAAA.*\",\n \"successUrl\": \"/openam/console\",\n \"realm\": \"/\"\n}"
}
]
}
