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
DECLARE @req int
-- Use "Chilkat_9_5_0.HttpRequest" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT
EXEC sp_OAMethod @req, 'AddParam', NULL, 'grant_type', 'refresh_token'
DECLARE @jsonParam2 int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonParam2 OUT
EXEC sp_OAMethod @jsonParam2, 'Emit', @sTmp0 OUT
EXEC sp_OAMethod @req, 'AddParam', NULL, 'refresh_token', @sTmp0
DECLARE @jsonParam3 int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonParam3 OUT
EXEC sp_OAMethod @jsonParam3, 'Emit', @sTmp0 OUT
EXEC sp_OAMethod @req, 'AddParam', NULL, 'client_id', @sTmp0
DECLARE @jsonParam4 int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonParam4 OUT
EXEC sp_OAMethod @jsonParam4, 'Emit', @sTmp0 OUT
EXEC sp_OAMethod @req, 'AddParam', NULL, 'client_secret', @sTmp0
EXEC sp_OAMethod @req, 'AddParam', NULL, 'scope', 'edit'
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostUrlEncoded', @resp OUT, 'https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token', @req
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 @req
EXEC @hr = sp_OADestroy @jsonParam2
EXEC @hr = sp_OADestroy @jsonParam3
EXEC @hr = sp_OADestroy @jsonParam4
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 @req
EXEC @hr = sp_OADestroy @jsonParam2
EXEC @hr = sp_OADestroy @jsonParam3
EXEC @hr = sp_OADestroy @jsonParam4
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)
-- {
-- "access_token": "eyJ0eXAiOiJKV1.cyI6Imh0dHA6Ly9vcGVuYW0uZ",
-- "refresh_token": "eyJ0CJhbGciOiJ.NzgxNCIsImlzcyI6Imh0dH",
-- "scope": "edit",
-- "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
DECLARE @access_token nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @access_token OUT, 'access_token'
DECLARE @refresh_token nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @refresh_token OUT, 'refresh_token'
DECLARE @scope nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @scope OUT, 'scope'
DECLARE @token_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @token_type OUT, 'token_type'
DECLARE @expires_in int
EXEC sp_OAMethod @jResp, 'IntOf', @expires_in OUT, 'expires_in'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
EXEC @hr = sp_OADestroy @jsonParam2
EXEC @hr = sp_OADestroy @jsonParam3
EXEC @hr = sp_OADestroy @jsonParam4
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
--data-urlencode 'grant_type=refresh_token'
--data-urlencode 'refresh_token={{refresh_token}}'
--data-urlencode 'client_id={{postmanConfidentialClientId}}'
--data-urlencode 'client_secret={{postmanClientSecret}}'
--data-urlencode 'scope=edit'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/access_token
Postman Collection Item JSON
{
"name": "Step 4: Refresh the Access Token",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
"var jsonData = JSON.parse(responseBody);",
"",
"pm.test(\"Response contains new refresh_token\", function () {",
" pm.expect(jsonData.refresh_token).to.not.eql(pm.globals.get(\"refresh_token\"));",
"});",
"",
"pm.test(\"Response contains new access_token\", function () {",
" pm.expect(jsonData.access_token).to.not.eql(pm.globals.get(\"access_token\"));",
"});",
"",
"",
"",
"if(jsonData.access_token && jsonData.access_token != \"\" && jsonData.access_token != pm.globals.get(\"access_token\"))",
"{",
" pm.globals.set(\"access_token\", jsonData.access_token);",
"}",
"",
"if(jsonData.refresh_token && jsonData.refresh_token != \"\" && jsonData.refresh_token != pm.globals.get(\"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\");",
"});",
"",
"pm.test(\"Response contains refresh_token\", function () {",
" pm.expect(jsonData.refresh_token).to.be.a(\"string\");",
"});",
"",
"",
"",
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "grant_type",
"value": "refresh_token",
"description": "The Grant Type supported by AM.",
"type": "text"
},
{
"key": "refresh_token",
"value": "{{refresh_token}}",
"description": "The refresh token.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanConfidentialClientId}}",
"description": "The ID of the OAuth Confidential Client.",
"type": "text"
},
{
"key": "client_secret",
"value": "{{postmanClientSecret}}",
"description": "The secret of the OAuth Confidential Client. See the ForgeRock documentation for stronger methods of client authentication.",
"type": "text"
},
{
"key": "scope",
"value": "edit",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/access_token",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"access_token"
]
},
"description": "Use a refresh token to ask for a new access token."
},
"response": [
{
"name": "Example - new access and refresh tokens",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "grant_type",
"value": "refresh_token",
"description": "The Grant Type supported by AM.",
"type": "text"
},
{
"key": "refresh_token",
"value": "{{refresh_token}}",
"description": "The refresh token.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanConfidentialClientId}}",
"description": "The ID of the OAuth Confidential Client.",
"type": "text"
},
{
"key": "client_secret",
"value": "{{postmanClientSecret}}",
"description": "The secret of the OAuth Confidential Client. See the ForgeRock documentation for stronger methods of client authentication.",
"type": "text"
},
{
"key": "scope",
"value": "edit",
"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": "1627"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:21:50 GMT"
}
],
"cookie": [
],
"body": "{\n \"access_token\": \"eyJ0eXAiOiJKV1.cyI6Imh0dHA6Ly9vcGVuYW0uZ\",\n \"refresh_token\": \"eyJ0CJhbGciOiJ.NzgxNCIsImlzcyI6Imh0dH\",\n \"scope\": \"edit\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3599\n}"
}
]
}
