Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vReq
Handle hoReq
Handle hoJsonParam2
Handle hoJsonParam5
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sUser_code
String sDevice_code
Integer iInterval
String sVerification_uri
Integer iExpires_in
String sVerification_url
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Send ComAddParam To hoReq "response_type" "device_code"
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonParam2
If (Not(IsComObjectCreated(hoJsonParam2))) Begin
Send CreateComObject of hoJsonParam2
End
Get ComEmit Of hoJsonParam2 To sTemp1
Send ComAddParam To hoReq "client_id" sTemp1
Send ComAddParam To hoReq "scope" "manage"
Send ComAddParam To hoReq "code_challenge_method" "S256"
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonParam5
If (Not(IsComObjectCreated(hoJsonParam5))) Begin
Send CreateComObject of hoJsonParam5
End
Get ComEmit Of hoJsonParam5 To sTemp1
Send ComAddParam To hoReq "code_challenge" sTemp1
Send ComAddHeader To hoReq "Authorization" "Bearer <access_token>"
Get pvComObject of hoReq to vReq
Get ComPostUrlEncoded Of hoHttp "https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/device/code" vReq To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "user_code": "x3W2JEFJ",
// "device_code": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsIm5iZiI6MTU5NzMyMTE0OCwidXNlcl9jb2RlIjoieDNXMkpFRkoiLCJpc3MiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsImV4cCI6MTU5NzMyMTQ0OCwiaWF0IjoxNTk3MzIxMTQ4LCJqdGkiOiIxYWI0MTE5Yy0yYjE4LTQxYWYtYjZjMC1iNTRmZTQxZWZhNjEifQ.gCoWICyPwJhD7LshgpfLpc9zEt6iUrsjmbGv6yk2kW0",
// "interval": 5,
// "verification_uri": "http://openam.example.com:8080/openam/oauth2/device/user",
// "expires_in": 300,
// "verification_url": "http://openam.example.com:8080/openam/oauth2/device/user"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "user_code" To sUser_code
Get ComStringOf Of hoJResp "device_code" To sDevice_code
Get ComIntOf Of hoJResp "interval" To iInterval
Get ComStringOf Of hoJResp "verification_uri" To sVerification_uri
Get ComIntOf Of hoJResp "expires_in" To iExpires_in
Get ComStringOf Of hoJResp "verification_url" To sVerification_url
End_Procedure
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
--data-urlencode 'response_type=device_code'
--data-urlencode 'client_id={{postmanPublicClientId}}'
--data-urlencode 'scope=manage'
--data-urlencode 'code_challenge_method=S256'
--data-urlencode 'code_challenge={{code_challenge}}'
https://<tenant-name>.forgeblocks.com/am/oauth2/realms/root/realms/alpha/device/code
Postman Collection Item JSON
{
"name": "Step 2: Get User Code and Device Code",
"event": [
{
"listen": "test",
"script": {
"exec": [
"const jsonData = pm.response.json();",
"",
"if(pm.response.code == 200)",
"{",
" if(jsonData.user_code && jsonData.user_code != \"\") {",
" pm.globals.set(\"user_code\", jsonData.user_code);",
" }",
"",
" if(jsonData.device_code && jsonData.device_code != \"\") {",
" pm.globals.set(\"device_code\", jsonData.device_code);",
" }",
"}",
"",
"// Tests",
"",
"pm.test(\"Status code is 200\", () => {",
" pm.expect(pm.response.code).to.eql(200);",
"});",
"",
"pm.test(\"Response contains `user_code`.\", function () {",
" pm.expect(jsonData.user_code).to.be.a(\"string\");",
"});",
"",
"pm.test(\"Response contains `device_code`.\", function () {",
" pm.expect(jsonData.device_code).to.be.a(\"string\");",
"});"
],
"type": "text/javascript"
}
},
{
"listen": "prerequest",
"script": {
"exec": [
"function base64URLEncode(words) {",
" return CryptoJS.enc.Base64.stringify(words)",
" .replace(/\\+/g, '-')",
" .replace(/\\//g, '_')",
" .replace(/=/g, '');",
"}",
"const code_verifier = base64URLEncode(CryptoJS.lib.WordArray.random(50));",
"const code_challenge = base64URLEncode(CryptoJS.SHA256(code_verifier));",
"",
"pm.globals.set(\"code_challenge\", code_challenge);",
"pm.globals.set(\"code_verifier\", code_verifier);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "response_type",
"value": "device_code",
"description": "Response types this client will support and use.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanPublicClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "scope",
"value": "manage",
"description": "Strings that are presented to the user for approval and included in tokens so that the protected resource may make decisions about what to give access to.",
"type": "text"
},
{
"key": "code_challenge_method",
"value": "S256",
"description": "The method used to generate the code challenge.",
"type": "text"
},
{
"key": "code_challenge",
"value": "{{code_challenge}}",
"description": "The generated code challenge.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/device/code",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"device",
"code"
]
},
"description": "Receive a user code and a device code, which can be used to provide consent.\n\n\n\n"
},
"response": [
{
"name": "Example",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "response_type",
"value": "device_code",
"description": "Response types this client will support and use.",
"type": "text"
},
{
"key": "client_id",
"value": "{{postmanPublicClientId}}",
"description": "The ID of the Confidential OAuth Client.",
"type": "text"
},
{
"key": "scope",
"value": "manage",
"description": "Strings that are presented to the user for approval and included in tokens so that the protected resource may make decisions about what to give access to.",
"type": "text"
},
{
"key": "code_challenge_method",
"value": "S256",
"description": "The method used to generate the code challenge.",
"type": "text"
},
{
"key": "code_challenge",
"value": "{{code_challenge}}",
"description": "The generated code challenge.",
"type": "text"
}
]
},
"url": {
"raw": "{{amUrl}}/oauth2{{realm}}/device/code",
"host": [
"{{amUrl}}"
],
"path": [
"oauth2{{realm}}",
"device",
"code"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Content-Length",
"value": "610"
},
{
"key": "Date",
"value": "Thu, 13 Aug 2020 12:19:08 GMT"
}
],
"cookie": [
],
"body": "{\n \"user_code\": \"x3W2JEFJ\",\n \"device_code\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsIm5iZiI6MTU5NzMyMTE0OCwidXNlcl9jb2RlIjoieDNXMkpFRkoiLCJpc3MiOiJodHRwOi8vb3BlbmFtLmV4YW1wbGUuY29tOjgwODAvb3BlbmFtL29hdXRoMiIsImV4cCI6MTU5NzMyMTQ0OCwiaWF0IjoxNTk3MzIxMTQ4LCJqdGkiOiIxYWI0MTE5Yy0yYjE4LTQxYWYtYjZjMC1iNTRmZTQxZWZhNjEifQ.gCoWICyPwJhD7LshgpfLpc9zEt6iUrsjmbGv6yk2kW0\",\n \"interval\": 5,\n \"verification_uri\": \"http://openam.example.com:8080/openam/oauth2/device/user\",\n \"expires_in\": 300,\n \"verification_url\": \"http://openam.example.com:8080/openam/oauth2/device/user\"\n}"
}
]
}
