Chilkat Online Tools

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

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// 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 = new CkXml();
$xml->put_Tag('user');
$xml->UpdateChildContent('roles|role|name','Admin');
$xml->UpdateChildContent('roles|role[1]|name','User');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

$sbRequestBody = new CkStringBuilder();
$xml->GetXmlSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/users/:id?fields=[\'id\',{\'roles\':[\'name\']}]',$sbRequestBody,'utf-8','application/xml',false,false);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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": [
  ]
}