added more API documentation

This commit is contained in:
2026-06-09 00:11:47 +02:00
parent 697f0cc1f9
commit a89d467930
8 changed files with 360 additions and 6 deletions

View File

@@ -0,0 +1,57 @@
# DELETE Permission
This API call deletes a permission. This is only allowed by the superuser.
#### Location
```
/api/v1/portal-management/permissions/
```
#### Permissions required
being `superuser`.
#### Body parameters
| Parameter | Type | Required | Description |
| --------------- | ---- | -------- | ---------------------------- |
| permission_uuid | uuid | yes | Unique id of the permission, |
### Example Body (json)
```json
{
"permission_uuid": "e0a60eba-52f6-11f1-8bcc-bc2411125ba4",
}
```
### Example Request
```php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/permissions/',
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.