58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
# GET Permissions
|
|
This call gets all the permissions data.
|
|
|
|
#### Location
|
|
```
|
|
/api/v1/portal-management/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
|
|
```php
|
|
|
|
$curl = curl_init();
|
|
curl_setopt_array($curl, array(
|
|
CURLOPT_URL => $baseUrl . '/api/v1/portal-management/permissions/' . '?builder[0][where][0]=permission_name&builder[0][where][1]=admin-portalsettings',
|
|
CURLOPT_CUSTOMREQUEST => 'GET',
|
|
CURLOPT_RETURNTRANSFER => true,
|
|
CURLOPT_HTTPHEADER => [
|
|
'Authorization: Bearer ' . $token,
|
|
'Content-Type: application/json'
|
|
]
|
|
));
|
|
|
|
$response = curl_exec($curl);
|
|
|
|
curl_close($curl);
|
|
echo $response;
|
|
```
|
|
|
|
### Example Response
|
|
```json
|
|
[
|
|
{
|
|
"permission_uuid":"1d018159-3109-11f0-9300-7e99ed98b725",
|
|
"permission_name":"admin-portalsettings",
|
|
"permission_slugify":"admin-portalsettings",
|
|
"permission_description":"Grants access to modify the global settings. It is advisable to restrict this permission to only the highest-level administrators.",
|
|
"permission_create_timestamp":1749933229,
|
|
"permission_modified_timestamp":null,
|
|
"module_uuid":"0f044275-1744-444c-9627-736310d7997e"
|
|
}
|
|
]
|
|
```
|
|
|
|
#### 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. |