Roles

Last updated 6 months ago

get

Return a list of all available permissions.

Authorizations

Responses

get

GET /api/admin/permissions HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

No content

get

List all current roles in the system.

Authorizations

Responses

Responseall of[]

get

GET /api/admin/roles HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "Super Administrator",
    "permissions": []
  }
]

get

Retrieve details for a single current role.

Authorizations

Path parameters

idinteger · int64Required

Role ID

Responses

Responseall of

get

GET /api/admin/role/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "name": "Super Administrator",
  "permissions": []
}

delete

Delete a single role.

Authorizations

Path parameters

idinteger · int64Required

Role ID

Responses

delete

DELETE /api/admin/role/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}

post

Create a new role.

Authorizations

Body

all ofOptional

Responses

Responseall of

post

POST /api/admin/roles HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "id": 1,
  "name": "Super Administrator",
  "permissions": []
}

{
  "id": 1,
  "name": "Super Administrator",
  "permissions": []
}

put

Update details of a single role.

Authorizations

Path parameters

idinteger · int64Required

Role ID

Body

all ofOptional

Responses

put

PUT /api/admin/role/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "id": 1,
  "name": "Super Administrator",
  "permissions": []
}

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}