Chilkat Online Tools

phpExt / Cognite API v1 / List groups

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();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('all','false');

$http->SetRequestHeader('api-key','{{api-key}}');

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/api/v1/projects/{{project}}/groups',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

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


?>

Curl Command

curl -G -d "all=false"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/groups

Postman Collection Item JSON

{
  "id": "getGroups",
  "name": "List groups",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "groups"
      ],
      "query": [
        {
          "key": "all",
          "description": "Whether to get all groups, only available with the groups:list acl.",
          "value": "false",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "Retrieves a list of groups the asking service account is a member of. Service accounts with groups:list capability can optionally ask for all groups in a project."
  }
}