Chilkat Online Tools

PureBasic / Coupa Postman Collection - OAuth - Master / Set / add roles on a user record

Back to Collection Items

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkXml.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 XML: Generate Code to Create XML

    ; The following XML is sent in the request body.

    ; <?xml version="1.0" encoding="utf-8"?>
    ; <user>
    ;     <roles>
    ;         <role>
    ;             <name>Admin</name>
    ;         </role>
    ;         <role>
    ;             <name>User</name>
    ;         </role>
    ;     </roles>
    ; </user>
    ; 

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::setCkTag(xml, "user")
    CkXml::ckUpdateChildContent(xml,"roles|role|name","Admin")
    CkXml::ckUpdateChildContent(xml,"roles|role[1]|name","User")

    ; Adds the "Authorization: Bearer <access_token>" header.
    CkHttp::setCkAuthToken(http, "<access_token>")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckGetXmlSb(xml,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/users/:id?fields=[" + Chr(34) + "id" + Chr(34) + ",{" + Chr(34) + "roles" + Chr(34) + ":[" + Chr(34) + "name" + Chr(34) + "]}]",sbRequestBody,"utf-8","application/xml",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(xml)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkXml::ckDispose(xml)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '<user>
   <roles>
      <role>
         <name>Admin</name>
      </role>
      <role>
         <name>User</name>
      </role>
    </roles>
</user>'
https://domain.com/users/:id?fields=["id",{"roles":["name"]}]

Postman Collection Item JSON

{
  "name": "Set / add roles on a user record",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "<user>\n   <roles>\n      <role>\n         <name>Admin</name>\n      </role>\n      <role>\n         <name>User</name>\n      </role>\n    </roles>\n</user>",
      "options": {
        "raw": {
          "language": "xml"
        }
      }
    },
    "url": {
      "raw": "{{URL}}/users/:id?fields=[\"id\",{\"roles\":[\"name\"]}]",
      "host": [
        "{{URL}}"
      ],
      "path": [
        "users",
        ":id"
      ],
      "query": [
        {
          "key": "fields",
          "value": "[\"id\",{\"roles\":[\"name\"]}]"
        }
      ],
      "variable": [
        {
          "key": "id",
          "value": "279"
        }
      ]
    },
    "description": "The process of updating user roles involves two API calls - 1) Remove all roles and 2) Set/add the roles on the user record. "
  },
  "response": [
  ]
}