Skip to content

GET Group permissions

This will get all the permissions assigned to user-groups.

Location

/api/v1/portal-management/group-permissions/

Permissions required

admin-access-control-permissions RO.

Body parameters

Parameter Type Required Description
builder[0][where][0] string no
builder[0][where][1] string no

Example Body (json)

None.

Example Request

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $baseUrl . '/api/v1/portal-management/group-permissions/' . '?builder[0][where][0]=user_group_uuid&builder[0][where][1]=0e1c6269-0da5-11f0-9300-7e99ed98b725',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
    ],
]);

$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);

if ($response === false) {
    echo curl_error($curl);
}

curl_close($curl);

Example Response

[
   {
      "permission_uuid":"11abc93d-c265-11f0-95da-7e99ed98b725",
      "user_group_uuid":"0e1c6269-0da5-11f0-9300-7e99ed98b725",
      "permission_value":"RW",
      "permission_restrict_to_tenant":0
   },
   {
      "permission_uuid":"1425fa24-2b6b-11f0-9300-7e99ed98b725",
      "user_group_uuid":"0e1c6269-0da5-11f0-9300-7e99ed98b725",
      "permission_value":"RW",
      "permission_restrict_to_tenant":0
   },
   ...
]

Known errors or issues.

None are known at the time If you do encounter issues and get an http code in return, check the response codes on this page.