PureBasic / Orchestrator / 1b. Authenticate (On-Premise)
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "tenancyName": "{{tenantName}}",
; "usernameOrEmailAddress": "{{usernameOrEmailAddress}}",
; "password": "{{password}}"
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"tenancyName","{{tenantName}}")
CkJsonObject::ckUpdateString(json,"usernameOrEmailAddress","{{usernameOrEmailAddress}}")
CkJsonObject::ckUpdateString(json,"password","{{password}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"User-Agent","")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/Account/Authenticate","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "result": "ND_kEaqVx4__SQ0zNEA3vV15ovYqXvpHnpYEnbKKHSjcc0ENIrOzgmj67uXOAxq--lyAvyUMIRp0i0XAAIOQHA_ekFz6idQBCYFKvRTWttYs8xD1pRRIP-pchsbJYhI-QVxrrd0H7PXourk6y0Nt049qWYP-2XrU6oziEX7usl6zK45pOQ4Iut5nmOFQsnd5IMIGBRmdH0fh3hbCtSgQ22S28a44PZHeRCIqb5gKMQKZ0UGvl4sgvw6EFygybPajmPKHQ-oAzNpXamMeicq7y2AM7wJWoUIalE7O0Z3DPogi0U47CqtVVmJfQ4R7OoNM8MhIlqfPoN-IEIULPll4fgPDAgY54iYMYLbXgrFBjSEC1lGMpkTO-40xBbIjoBeL0OV3mVazgZcysqQ7BcwvtpRnZX_VK4V_Pwhzt4ZItsCFS8yOQM0FblT6LBn87JZlQ3nx9FIEo9pny0kHo9v9QJ_iU9nsFNPB71qa1JU6apLBhq5Rj7_PSrm0CfPOizIXRuq0GZ2uXdseR0Xk79-123",
; "targetUrl": null,
; "success": true,
; "error": null,
; "unAuthorizedRequest": false,
; "__abp": true
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
result.s = CkJsonObject::ckStringOf(jResp,"result")
targetUrl.s = CkJsonObject::ckStringOf(jResp,"targetUrl")
success.i = CkJsonObject::ckBoolOf(jResp,"success")
error.s = CkJsonObject::ckStringOf(jResp,"error")
unAuthorizedRequest.i = CkJsonObject::ckBoolOf(jResp,"unAuthorizedRequest")
v__abp.i = CkJsonObject::ckBoolOf(jResp,"__abp")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "User-Agent: "
-d '{
"tenancyName": "{{tenantName}}",
"usernameOrEmailAddress": "{{usernameOrEmailAddress}}",
"password": "{{password}}"
}'
https://domain.com/api/Account/Authenticate
Postman Collection Item JSON
{
"name": "1b. Authenticate (On-Premise)",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Token Saved\", function () {",
" var oldToken = pm.globals.get(\"token\");",
" var jsonData = pm.response.json();",
" ",
" pm.globals.set(\"token\", jsonData.result);",
" pm.expect(pm.globals.get(\"token\")).to.not.equal(oldToken);",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "User-Agent",
"value": ""
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"tenancyName\": \"{{tenantName}}\",\n\t\"usernameOrEmailAddress\": \"{{usernameOrEmailAddress}}\",\n\t\"password\": \"{{password}}\"\n}"
},
"url": {
"raw": "{{url}}/api/Account/Authenticate",
"host": [
"{{url}}"
],
"path": [
"api",
"Account",
"Authenticate"
]
},
"description": "**FOR ON-PREMISE ORCHESTRATOR USERS**\n\nThe first step is to send Orchestrator your **_tenant name_**, **_username_**, and **_password_** so it knows who is making these calls. Orchestrator will return a token that authenticates all subsequent actions.\n\n**Note:** Don't worry about copying and pasting any tokens; this Postman collection does it for you! You can make any call and it will first ensure that a valid token already exists, retrieving a new token otherwise."
},
"response": [
{
"name": "Authenticate",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "User-Agent",
"value": "",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"tenancyName\": \"{{tenantName}}\",\n\t\"usernameOrEmailAddress\": \"{{usernameOrEmailAddress}}\",\n\t\"password\": \"{{password}}\"\n}"
},
"url": {
"raw": "{{url}}/api/Account/Authenticate",
"host": [
"{{url}}"
],
"path": [
"api",
"Account",
"Authenticate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "CF-RAY",
"value": "43b30aa3fdd1bf07-FRA",
"name": "CF-RAY",
"description": "Custom header"
},
{
"key": "Cache-Control",
"value": "no-store, must-revalidate, no-cache, max-age=0",
"name": "Cache-Control",
"description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"
},
{
"key": "Connection",
"value": "keep-alive",
"name": "Connection",
"description": "Options that are desired for the connection"
},
{
"key": "Content-Encoding",
"value": "gzip",
"name": "Content-Encoding",
"description": "The type of encoding used on the data."
},
{
"key": "Content-Length",
"value": "798",
"name": "Content-Length",
"description": "The length of the response body in octets (8-bit bytes)"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8",
"name": "Content-Type",
"description": "The mime type of this content"
},
{
"key": "Date",
"value": "Mon, 16 Jul 2018 08:19:02 GMT",
"name": "Date",
"description": "The date and time that the message was sent"
},
{
"key": "Expect-CT",
"value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"",
"name": "Expect-CT",
"description": "Custom header"
},
{
"key": "Server",
"value": "cloudflare",
"name": "Server",
"description": "A name for the server"
},
{
"key": "Set-Cookie",
"value": "; SameSite=lax",
"name": "Set-Cookie",
"description": "an HTTP cookie"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains",
"name": "Strict-Transport-Security",
"description": "A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."
},
{
"key": "Vary",
"value": "Accept-Encoding",
"name": "Vary",
"description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."
},
{
"key": "X-Content-Type-Options",
"value": "nosniff",
"name": "X-Content-Type-Options",
"description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"
},
{
"key": "X-Frame-Options",
"value": "DENY",
"name": "X-Frame-Options",
"description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"
},
{
"key": "api-supported-versions",
"value": "5.0",
"name": "api-supported-versions",
"description": "Custom header"
}
],
"cookie": [
{
"expires": "Invalid Date",
"httpOnly": true,
"domain": "uipath.com",
"path": "/",
"secure": true,
"value": "d3b89a558feb68050f4b847c971f595771513704902",
"key": "__cfduid"
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/QueueProcessingRecords",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api/RobotsService",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Processes",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Settings",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Robots",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Queues",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Assets",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api/Account",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Users",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Jobs",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api/Logs",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/Account",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/",
"secure": false,
"value": ""
},
{
"expires": "Invalid Date",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/",
"secure": false,
"value": "GC-osp2U-YDhoXTOqXnUp3DaN1cN_siVCaNVue_jljOcqJLYHQrRk5msz52KHL8XauydRYx_3JyjLtLDpItypCPdEL20jFnxlF2g-f86Qk41",
"key": "__RequestVerificationToken"
}
],
"body": "{\n \"result\": \"ND_kEaqVx4__SQ0zNEA3vV15ovYqXvpHnpYEnbKKHSjcc0ENIrOzgmj67uXOAxq--lyAvyUMIRp0i0XAAIOQHA_ekFz6idQBCYFKvRTWttYs8xD1pRRIP-pchsbJYhI-QVxrrd0H7PXourk6y0Nt049qWYP-2XrU6oziEX7usl6zK45pOQ4Iut5nmOFQsnd5IMIGBRmdH0fh3hbCtSgQ22S28a44PZHeRCIqb5gKMQKZ0UGvl4sgvw6EFygybPajmPKHQ-oAzNpXamMeicq7y2AM7wJWoUIalE7O0Z3DPogi0U47CqtVVmJfQ4R7OoNM8MhIlqfPoN-IEIULPll4fgPDAgY54iYMYLbXgrFBjSEC1lGMpkTO-40xBbIjoBeL0OV3mVazgZcysqQ7BcwvtpRnZX_VK4V_Pwhzt4ZItsCFS8yOQM0FblT6LBn87JZlQ3nx9FIEo9pny0kHo9v9QJ_iU9nsFNPB71qa1JU6apLBhq5Rj7_PSrm0CfPOizIXRuq0GZ2uXdseR0Xk79-123\",\n \"targetUrl\": null,\n \"success\": true,\n \"error\": null,\n \"unAuthorizedRequest\": false,\n \"__abp\": true\n}"
}
]
}
