Add notification calls to API docs

master
Skylar Ittner 6 years ago
parent 8ff71c6d8e
commit 6e07bcfea5

@ -42,4 +42,8 @@ If the request is not well-formed (missing required arguments, invalid API key,
| `getgroupsbyuser` | `uid` or `username` | Get a list of groups as `[{"id", "name"}]` the given user (by ID or username) is a member of.
| `getgroups` | None | Get a list of all user groups in the database.
| `groupsearch` | `search` | Searches for groups with names containing the `search`. See `usersearch` for result format and more details. The differences are the fields returned (`id` and `name`) and the minimum query length (2 characters).
| `checkpin` | `pin`, `username` or `uid` | Check if the supplied PIN matches the user's PIN. Returns a boolean `pinvalid`. If no PIN is set, returns a `status ERROR`, `pinvalid false`, and `nopinset true`.
| `checkpin` | `pin`, `username` or `uid` | Check if the supplied PIN matches the user's PIN. Returns a boolean `pinvalid`. If no PIN is set, returns a `status ERROR`, `pinvalid false`, and `nopinset true`.
| `getnotifications` | `username` or `uid` | Get notifications for the user. When successful, returns an array `notifications` with items similar to: `{"id": 1, "timestamp": "YYYY-MM-DD HH:MM:SS", "title": "text", "content": "text", "url": "text", "seen": false, "sensitive": false}`
| `readnotification` | `username` or `uid`, `id` | Mark the notification identified by the user and notification ID as read. Sets `seen` to `true` in future calls to `getnotifications`, and changes how the notification is displayed in the UI.
| `addnotification` | `username` or `uid`, `title`, `content`, `timestamp` (optional, defaults to current date/time), `url` (optional, defaults to empty string), `sensitive` (optional, defaults to `false`) | Add a notification for the given user with the content.
| `deletenotification` | `username` or `uid`, `id` | Delete a notification.

@ -10,9 +10,5 @@ AccountHub is a web application enabling secure self-serve account management.
* Prevents some types of attacks while legitimate users can simply click an image or answer a question to login.
* __Detailed security logs__
* Records every login attempt, password change, invalid CAPTCHA, or other security-related activity, tracking client IP address and activity timestamp.
* __Easily-extendable dashboard__
* Add additional dashboard widgets with as little as five lines of code, for easy access to and overviews of other applications.
* __Modern__
* AccountHub uses the latest open web technology to provide a seamless, uniform user experience on phones, tablets, desktops, and laptops, from anywhere in the world.
* __For users and IT__
* Users will appreciate how easy it is to manage their accounts, while tech support won't have as many login-related tickets to deal with.
* AccountHub uses the latest open web technology to provide a seamless, uniform user experience on phones, tablets, desktops, and laptops, from anywhere in the world.

@ -8,6 +8,8 @@ theme:
palette:
primary: 'orange'
accent: 'orange'
extra_javascript:
- track.js
site_author: Netsyms Technologies
repo_name: 'Business/AccountHub'
repo_url: 'https://source.netsyms.com/Business/AccountHub'

Loading…
Cancel
Save