Chilkat Online Tools

delphiDll / DocuSign REST API / Deletes one or more users from a gro

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "users": [
//     {
//       "userName": "sample string 1",
//       "userId": "sample string 2",
//       "email": "sample string 3",
//       "userType": "sample string 4",
//       "userStatus": "sample string 5",
//       "uri": "sample string 6",
//       "loginStatus": "sample string 7",
//       "sendActivationEmail": "sample string 8",
//       "activationAccessCode": "sample string 9"
//     }
//   ]
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'users[0].userName','sample string 1');
CkJsonObject_UpdateString(json,'users[0].userId','sample string 2');
CkJsonObject_UpdateString(json,'users[0].email','sample string 3');
CkJsonObject_UpdateString(json,'users[0].userType','sample string 4');
CkJsonObject_UpdateString(json,'users[0].userStatus','sample string 5');
CkJsonObject_UpdateString(json,'users[0].uri','sample string 6');
CkJsonObject_UpdateString(json,'users[0].loginStatus','sample string 7');
CkJsonObject_UpdateString(json,'users[0].sendActivationEmail','sample string 8');
CkJsonObject_UpdateString(json,'users[0].activationAccessCode','sample string 9');

// Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_putAuthToken(http,'{{accessToken}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'DELETE','https://domain.com/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

Curl Command

curl -X DELETE
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "email": "sample string 3",
      "userType": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "loginStatus": "sample string 7",
      "sendActivationEmail": "sample string 8",
      "activationAccessCode": "sample string 9"
    }
  ]
}'
https://domain.com/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users

Postman Collection Item JSON

{
  "name": "Deletes one or more users from a gro",
  "request": {
    "method": "DELETE",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"users\": [\n    {\n      \"userName\": \"sample string 1\",\n      \"userId\": \"sample string 2\",\n      \"email\": \"sample string 3\",\n      \"userType\": \"sample string 4\",\n      \"userStatus\": \"sample string 5\",\n      \"uri\": \"sample string 6\",\n      \"loginStatus\": \"sample string 7\",\n      \"sendActivationEmail\": \"sample string 8\",\n      \"activationAccessCode\": \"sample string 9\"\n    }\n  ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups/{{groupId}}/users",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups",
        "{{groupId}}",
        "users"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "groupId",
          "value": "{{groupId}}"
        }
      ]
    },
    "description": "Deletes one or more users from a group.\n"
  },
  "response": [
  ]
}