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
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept-API-Version', 'resource=2.1'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-OpenAM-Username', '{{postmanDemoUsername}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-OpenAM-Password', '{{postmanDemoPassword}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequest', @resp OUT, 'POST', 'https://<tenant-name>.forgeblocks.com/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=PasswordGrant'
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
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 @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": "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
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 @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
