Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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": "BooleanAttributeInputCallback",
-- "output": [
-- {
-- "name": "name",
-- "value": "preferences/updates"
-- },
-- {
-- "name": "prompt",
-- "value": "Send me news and updates"
-- },
-- {
-- "name": "required",
-- "value": false
-- },
-- {
-- "name": "policies",
-- "value": {}
-- },
-- {
-- "name": "failedPolicies",
-- "value": [
-- ]
-- },
-- {
-- "name": "validateOnly",
-- "value": false
-- },
-- {
-- "name": "value",
-- "value": false
-- }
-- ],
-- "input": [
-- {
-- "name": "IDToken1",
-- "value": false
-- },
-- {
-- "name": "IDToken1validateOnly",
-- "value": false
-- }
-- ],
-- "_id": 2
-- },
-- {
-- "type": "BooleanAttributeInputCallback",
-- "output": [
-- {
-- "name": "name",
-- "value": "preferences/marketing"
-- },
-- {
-- "name": "prompt",
-- "value": "Send me special offers and services"
-- },
-- {
-- "name": "required",
-- "value": false
-- },
-- {
-- "name": "policies",
-- "value": {}
-- },
-- {
-- "name": "failedPolicies",
-- "value": [
-- ]
-- },
-- {
-- "name": "validateOnly",
-- "value": false
-- },
-- {
-- "name": "value",
-- "value": false
-- }
-- ],
-- "input": [
-- {
-- "name": "IDToken2",
-- "value": false
-- },
-- {
-- "name": "IDToken2validateOnly",
-- "value": false
-- }
-- ],
-- "_id": 3
-- }
-- ]
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'authId', '{{authId}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].type', 'BooleanAttributeInputCallback'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[0].name', 'name'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[0].value', 'preferences/updates'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[1].name', 'prompt'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[1].value', 'Send me news and updates'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[2].name', 'required'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[0].output[2].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[3].name', 'policies'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'callbacks[0].output[3].value'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[4].name', 'failedPolicies'
EXEC sp_OAMethod @json, 'UpdateNewArray', @success OUT, 'callbacks[0].output[4].value'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[5].name', 'validateOnly'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[0].output[5].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].output[6].name', 'value'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[0].output[6].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].input[0].name', 'IDToken1'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[0].input[0].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[0].input[1].name', 'IDToken1validateOnly'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[0].input[1].value', 0
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'callbacks[0]._id', 2
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].type', 'BooleanAttributeInputCallback'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[0].name', 'name'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[0].value', 'preferences/marketing'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[1].name', 'prompt'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[1].value', 'Send me special offers and services'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[2].name', 'required'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[1].output[2].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[3].name', 'policies'
EXEC sp_OAMethod @json, 'UpdateNewObject', @success OUT, 'callbacks[1].output[3].value'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[4].name', 'failedPolicies'
EXEC sp_OAMethod @json, 'UpdateNewArray', @success OUT, 'callbacks[1].output[4].value'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[5].name', 'validateOnly'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[1].output[5].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].output[6].name', 'value'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[1].output[6].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].input[0].name', 'IDToken2'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[1].input[0].value', 0
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'callbacks[1].input[1].name', 'IDToken2validateOnly'
EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'callbacks[1].input[1].value', 0
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'callbacks[1]._id', 3
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept-API-Version', 'resource=2.0, protocol=1.0'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @tokenId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @tokenId OUT, 'tokenId'
DECLARE @successUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @successUrl OUT, 'successUrl'
DECLARE @realm nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @realm OUT, 'realm'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": "BooleanAttributeInputCallback",
"output": [
{
"name": "name",
"value": "preferences/updates"
},
{
"name": "prompt",
"value": "Send me news and updates"
},
{
"name": "required",
"value": false
},
{
"name": "policies",
"value": {}
},
{
"name": "failedPolicies",
"value": []
},
{
"name": "validateOnly",
"value": false
},
{
"name": "value",
"value": false
}
],
"input": [
{
"name": "IDToken1",
"value": false
},
{
"name": "IDToken1validateOnly",
"value": false
}
],
"_id": 2
},
{
"type": "BooleanAttributeInputCallback",
"output": [
{
"name": "name",
"value": "preferences/marketing"
},
{
"name": "prompt",
"value": "Send me special offers and services"
},
{
"name": "required",
"value": false
},
{
"name": "policies",
"value": {}
},
{
"name": "failedPolicies",
"value": []
},
{
"name": "validateOnly",
"value": false
},
{
"name": "value",
"value": false
}
],
"input": [
{
"name": "IDToken2",
"value": false
},
{
"name": "IDToken2validateOnly",
"value": false
}
],
"_id": 3
}
],
}'
https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Login
Postman Collection Item JSON
{
"name": "Step 2f: Handle Progressive 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": [
{
"description": "Specifies that the `/json/authenticate` endpoint uses JSON format for requests.",
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Specifies the version of the `/json/authenticate` endpoint to use.",
"key": "Accept-API-Version",
"value": "resource=2.0, protocol=1.0"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"authId\": \"{{authId}}\",\n \"callbacks\": [\n {\n \"type\": \"BooleanAttributeInputCallback\",\n \"output\": [\n {\n \"name\": \"name\",\n \"value\": \"preferences/updates\"\n },\n {\n \"name\": \"prompt\",\n \"value\": \"Send me news and updates\"\n },\n {\n \"name\": \"required\",\n \"value\": false\n },\n {\n \"name\": \"policies\",\n \"value\": {}\n },\n {\n \"name\": \"failedPolicies\",\n \"value\": []\n },\n {\n \"name\": \"validateOnly\",\n \"value\": false\n },\n {\n \"name\": \"value\",\n \"value\": false\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken1\",\n \"value\": false\n },\n {\n \"name\": \"IDToken1validateOnly\",\n \"value\": false\n }\n ],\n \"_id\": 2\n },\n {\n \"type\": \"BooleanAttributeInputCallback\",\n \"output\": [\n {\n \"name\": \"name\",\n \"value\": \"preferences/marketing\"\n },\n {\n \"name\": \"prompt\",\n \"value\": \"Send me special offers and services\"\n },\n {\n \"name\": \"required\",\n \"value\": false\n },\n {\n \"name\": \"policies\",\n \"value\": {}\n },\n {\n \"name\": \"failedPolicies\",\n \"value\": []\n },\n {\n \"name\": \"validateOnly\",\n \"value\": false\n },\n {\n \"name\": \"value\",\n \"value\": false\n }\n ],\n \"input\": [\n {\n \"name\": \"IDToken2\",\n \"value\": false\n },\n {\n \"name\": \"IDToken2validateOnly\",\n \"value\": false\n }\n ],\n \"_id\": 3\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 `BooleanAttributeInputCallback` callbacks used by the *Progressive Profiling* nodes."
},
"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}"
}
]
}
