Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "authId": "{{authId}}",
// "callbacks": [
// {
// "type": "DeviceProfileCallback",
// "output": [
// {
// "name": "metadata",
// "value": true
// },
// {
// "name": "location",
// "value": true
// },
// {
// "name": "message",
// "value": "Collecting....."
// }
// ],
// "input": [
// {
// "name": "IDToken1",
// "value": "{\r\n \"identifier\":\"aec3fe784...o3Xjiizyb9=\",\r\n \"alias\":\"Example Pixel 3 XL\",\r\n \"metadata\":{\r\n \"platform\":{\r\n \"platform\":\"Android\",\r\n \"version\":28,\r\n \"device\":\"generic_x86_arm\",\r\n \"deviceName\":\"AOSP on IA Emulator\",\r\n \"model\":\"AOSP on IA Emulator\",\r\n \"brand\":\"google\",\r\n \"locale\":\"en_US\",\r\n \"timeZone\":\"America\/Vancouver\",\r\n \"jailBreakScore\":1\r\n },\r\n \"hardware\":{\r\n \"hardware\":\"ranchu\",\r\n \"manufacturer\":\"Google\",\r\n \"storage\":774,\r\n \"memory\":1494,\r\n \"cpu\":4,\r\n \"display\":{\r\n \"width\":1440,\r\n \"height\":2621,\r\n \"orientation\":1\r\n },\r\n \"camera\":{\r\n \"numberOfCameras\":2\r\n }\r\n },\r\n \"browser\":{\r\n \"agent\":\"Dalvik\/2.1.0 (Linux; U; Android 9; AOSP on IA Emulator Build\/PSR1.180720.117)\"\r\n },\r\n \"bluetooth\":{\r\n \"supported\":false\r\n },\r\n \"network\":{\r\n \"connected\":true\r\n },\r\n \"telephony\":{\r\n \"networkCountryIso\":\"us\",\r\n \"carrierName\":\"Android\"\r\n }\r\n },\r\n \"location\":{\r\n \"latitude\":{{$randomLatitude}},\r\n \"Longitude\":{{$randomLongitude}}\r\n }\r\n}"
// }
// ]
// }
// ]
// }
let json = CkoJsonObject()!
json.update("authId", value: "{{authId}}")
json.update("callbacks[0].type", value: "DeviceProfileCallback")
json.update("callbacks[0].output[0].name", value: "metadata")
json.updateBool("callbacks[0].output[0].value", value: true)
json.update("callbacks[0].output[1].name", value: "location")
json.updateBool("callbacks[0].output[1].value", value: true)
json.update("callbacks[0].output[2].name", value: "message")
json.update("callbacks[0].output[2].value", value: "Collecting.....")
json.update("callbacks[0].input[0].name", value: "IDToken1")
json.update("callbacks[0].input[0].value", value: "{\r\n \"identifier\":\"aec3fe784...o3Xjiizyb9=\",\r\n \"alias\":\"Example Pixel 3 XL\",\r\n \"metadata\":{\r\n \"platform\":{\r\n \"platform\":\"Android\",\r\n \"version\":28,\r\n \"device\":\"generic_x86_arm\",\r\n \"deviceName\":\"AOSP on IA Emulator\",\r\n \"model\":\"AOSP on IA Emulator\",\r\n \"brand\":\"google\",\r\n \"locale\":\"en_US\",\r\n \"timeZone\":\"America/Vancouver\",\r\n \"jailBreakScore\":1\r\n },\r\n \"hardware\":{\r\n \"hardware\":\"ranchu\",\r\n \"manufacturer\":\"Google\",\r\n \"storage\":774,\r\n \"memory\":1494,\r\n \"cpu\":4,\r\n \"display\":{\r\n \"width\":1440,\r\n \"height\":2621,\r\n \"orientation\":1\r\n },\r\n \"camera\":{\r\n \"numberOfCameras\":2\r\n }\r\n },\r\n \"browser\":{\r\n \"agent\":\"Dalvik/2.1.0 (Linux; U; Android 9; AOSP on IA Emulator Build/PSR1.180720.117)\"\r\n },\r\n \"bluetooth\":{\r\n \"supported\":false\r\n },\r\n \"network\":{\r\n \"connected\":true\r\n },\r\n \"telephony\":{\r\n \"networkCountryIso\":\"us\",\r\n \"carrierName\":\"Android\"\r\n }\r\n },\r\n \"location\":{\r\n \"latitude\":{{$randomLatitude}},\r\n \"Longitude\":{{$randomLongitude}}\r\n }\r\n}")
http.setRequestHeader("Content-Type", value: "application/json")
http.setRequestHeader("Accept-API-Version", value: "resource=2.0, protocol=1.0")
var resp: CkoHttpResponse? = http.postJson3("https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login", contentType: "application/json", json: json)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "tokenId": "N60dPV99pcqVVI.*AAJTSQACMDEAAANDVFMAAlMxAAA.*",
// "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
var tokenId: String? = jResp.string(of: "tokenId")
var successUrl: String? = jResp.string(of: "successUrl")
var realm: String? = jResp.string(of: "realm")
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept-API-Version: resource=2.0, protocol=1.0"
-d '{
"authId": "{{authId}}",
"callbacks": [
{
"type": "DeviceProfileCallback",
"output": [
{
"name": "metadata",
"value": true
},
{
"name": "location",
"value": true
},
{
"name": "message",
"value": "Collecting....."
}
],
"input": [
{
"name": "IDToken1",
"value": "{\r\n \"identifier\":\"aec3fe784...o3Xjiizyb9=\",\r\n \"alias\":\"Example Pixel 3 XL\",\r\n \"metadata\":{\r\n \"platform\":{\r\n \"platform\":\"Android\",\r\n \"version\":28,\r\n \"device\":\"generic_x86_arm\",\r\n \"deviceName\":\"AOSP on IA Emulator\",\r\n \"model\":\"AOSP on IA Emulator\",\r\n \"brand\":\"google\",\r\n \"locale\":\"en_US\",\r\n \"timeZone\":\"America\/Vancouver\",\r\n \"jailBreakScore\":1\r\n },\r\n \"hardware\":{\r\n \"hardware\":\"ranchu\",\r\n \"manufacturer\":\"Google\",\r\n \"storage\":774,\r\n \"memory\":1494,\r\n \"cpu\":4,\r\n \"display\":{\r\n \"width\":1440,\r\n \"height\":2621,\r\n \"orientation\":1\r\n },\r\n \"camera\":{\r\n \"numberOfCameras\":2\r\n }\r\n },\r\n \"browser\":{\r\n \"agent\":\"Dalvik\/2.1.0 (Linux; U; Android 9; AOSP on IA Emulator Build\/PSR1.180720.117)\"\r\n },\r\n \"bluetooth\":{\r\n \"supported\":false\r\n },\r\n \"network\":{\r\n \"connected\":true\r\n },\r\n \"telephony\":{\r\n \"networkCountryIso\":\"us\",\r\n \"carrierName\":\"Android\"\r\n }\r\n },\r\n \"location\":{\r\n \"latitude\":{{$randomLatitude}},\r\n \"Longitude\":{{$randomLongitude}}\r\n }\r\n}"
}
]
}
]
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login
Postman Collection Item JSON
{
"name": "Step 2e: Handle Device Profile Callback",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const JSONResponse = JSON.parse(responseBody);",
"",
"// Did request have a callback?",
"if(JSONResponse.authId && JSONResponse.authId != \"\")",
"{",
" // Set `authId` variable",
" pm.globals.set(\"authId\", JSONResponse.authId);",
" ",
" // Determine next request based on detected callbacks",
" frUtils.detectCallbacks(responseBody);",
"}",
"",
"// Did request return SSO Token?",
"if(JSONResponse.tokenId && JSONResponse.tokenId != \"\")",
"{",
" // Set `demoSSOToken` variable",
" pm.globals.set(\"demoSSOToken\", JSONResponse.tokenId);",
"",
" // Remove `authId` variable",
" pm.globals.unset(\"authId\");",
" ",
" // Skip to session info request",
" postman.setNextRequest(\"Step 3: Get Session Info\");",
"}",
"",
"// Tests",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains tokenId or authId\", function () {",
" pm.expect(JSONResponse).to.have.any.keys('tokenId', 'authId');",
"});",
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disableCookies": true
},
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "Specifies that the `/json/authenticate` endpoint uses JSON format for requests."
},
{
"key": "Accept-API-Version",
"value": "resource=2.0, protocol=1.0",
"description": "Specifies the version of the `/json/authenticate` endpoint to use."
}
],
"body": {
"mode": "raw",
"raw": "{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"DeviceProfileCallback\",\n \"output\": [\n {\n \"name\": \"metadata\",\n \"value\": true\n },\n {\n \"name\": \"location\",\n \"value\": true\n },\n {\n \"name\": \"message\",\n \"value\": \"Collecting.....\"\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": \"{\\r\\n \\\"identifier\\\":\\\"aec3fe784...o3Xjiizyb9=\\\",\\r\\n \\\"alias\\\":\\\"Example Pixel 3 XL\\\",\\r\\n \\\"metadata\\\":{\\r\\n \\\"platform\\\":{\\r\\n \\\"platform\\\":\\\"Android\\\",\\r\\n \\\"version\\\":28,\\r\\n \\\"device\\\":\\\"generic_x86_arm\\\",\\r\\n \\\"deviceName\\\":\\\"AOSP on IA Emulator\\\",\\r\\n \\\"model\\\":\\\"AOSP on IA Emulator\\\",\\r\\n \\\"brand\\\":\\\"google\\\",\\r\\n \\\"locale\\\":\\\"en_US\\\",\\r\\n \\\"timeZone\\\":\\\"America\\/Vancouver\\\",\\r\\n \\\"jailBreakScore\\\":1\\r\\n },\\r\\n \\\"hardware\\\":{\\r\\n \\\"hardware\\\":\\\"ranchu\\\",\\r\\n \\\"manufacturer\\\":\\\"Google\\\",\\r\\n \\\"storage\\\":774,\\r\\n \\\"memory\\\":1494,\\r\\n \\\"cpu\\\":4,\\r\\n \\\"display\\\":{\\r\\n \\\"width\\\":1440,\\r\\n \\\"height\\\":2621,\\r\\n \\\"orientation\\\":1\\r\\n },\\r\\n \\\"camera\\\":{\\r\\n \\\"numberOfCameras\\\":2\\r\\n }\\r\\n },\\r\\n \\\"browser\\\":{\\r\\n \\\"agent\\\":\\\"Dalvik\\/2.1.0 (Linux; U; Android 9; AOSP on IA Emulator Build\\/PSR1.180720.117)\\\"\\r\\n },\\r\\n \\\"bluetooth\\\":{\\r\\n \\\"supported\\\":false\\r\\n },\\r\\n \\\"network\\\":{\\r\\n \\\"connected\\\":true\\r\\n },\\r\\n \\\"telephony\\\":{\\r\\n \\\"networkCountryIso\\\":\\\"us\\\",\\r\\n \\\"carrierName\\\":\\\"Android\\\"\\r\\n }\\r\\n },\\r\\n \\\"location\\\":{\\r\\n \\\"latitude\\\":{{$randomLatitude}},\\r\\n \\\"Longitude\\\":{{$randomLongitude}}\\r\\n }\\r\\n}\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?authIndexType=service&authIndexValue={{loginJourney}}",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
],
"query": [
{
"key": "authIndexType",
"value": "service",
"description": "Allows the request to configure the service (for example, an authentication tree) to use for this request."
},
{
"key": "authIndexValue",
"value": "{{loginJourney}}",
"description": "Specifies the name of the service to use for this request.\nOverride this value using the `amAuthenticationTree` Postman variable."
}
]
},
"description": "To respond to a callback, send back the whole JSON object with the missing `input` values filled.\n\nThis request shows how to respond to a `DeviceProfileCallback`.\n\nThe example data in the request body represents a Google Android emulator device."
},
"response": [
{
"name": "Success - authentication complete",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "Specifies that the `/json/authenticate` endpoint uses JSON format for requests."
},
{
"key": "Accept-API-Version",
"value": "resource=2.0, protocol=1.0",
"description": "Specifies the version of the `/json/authenticate` endpoint to use."
}
],
"body": {
"mode": "raw",
"raw": "{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"ChoiceCallback\",\n \"output\": [\n {\n \"name\": \"prompt\",\n \"value\": \"Succeed?\"\n },\n {\n \"name\": \"choices\",\n \"value\": [\n \"Yes\",\n \"No\"\n ]\n },\n {\n \"name\": \"defaultChoice\",\n \"value\": 0\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": 0\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{amUrl}}/json{{realm}}/authenticate?authIndexType=service&authIndexValue={{loginJourney}}",
"host": [
"{{amUrl}}"
],
"path": [
"json{{realm}}",
"authenticate"
],
"query": [
{
"key": "authIndexType",
"value": "service",
"description": "Allows the request to configure the service (for example, an authentication tree) to use for this request."
},
{
"key": "authIndexValue",
"value": "{{loginJourney}}",
"description": "Specifies the name of the service to use for this request.\nOverride this value using the `amAuthenticationTree` Postman variable."
}
]
}
},
"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": "iPlanetDirectoryPro=N60dPVcmOADQN170-8799pcqVVI.*AAJTSQACMDEAAlNLABw5QThIM0ZJd3RKcmNyWWYxSzlPaGhzcllsUXM9AAR0eXBlAANDVFMAAlMxAAA.*; Path=/; Domain=example.com; HttpOnly"
},
{
"key": "Set-Cookie",
"value": "amlbcookie=01; 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": "Wed, 12 Aug 2020 14:10:41 GMT"
}
],
"cookie": [
],
"body": "{\n \"tokenId\": \"N60dPV99pcqVVI.*AAJTSQACMDEAAANDVFMAAlMxAAA.*\",\n \"successUrl\": \"/openam/console\",\n \"realm\": \"/\"\n}"
}
]
}
