More API documentation

This commit is contained in:
2026-06-09 23:55:45 +02:00
parent a89d467930
commit 9d2892ad1d
8 changed files with 448 additions and 1 deletions

View File

@@ -0,0 +1,57 @@
# DELETE user group
This API call deletes a user-group.
#### Location
```
/api/v1/portal-management/user-groups/
```
#### Permissions required
`admin-access-control-user-groups` RW.
#### Body parameters
| Parameter | Type | Required | Description |
| --------------- | ---- | -------- | ---------------------------- |
| user_group_uuid | uuid | yes | Unique id of the user-group. |
### Example Body (json)
```json
{
"user_group_uuid": "d4cbf41b-6445-11f1-a54b-bc2411125ba4"
}
```
### Example Request
```php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/user-groups/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $json_payload,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $token,
'Content-Type: application/json',
'X-HTTP-Method-Override: DELETE'
],
]);
$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($response === false) {
echo curl_error($curl);
}
curl_close($curl);
```
### Example Response
```json
"Permission deleted successfully."
```
#### 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.