diff --git a/docs/API Documentation.md b/docs/API Documentation.md index 792298e..2234674 100644 --- a/docs/API Documentation.md +++ b/docs/API Documentation.md @@ -35,3 +35,10 @@ If the request is not well-formed (missing required arguments, invalid API key, | `permission` | `uid` or `username`, `code` | Returns boolean `has_permission` if the given user has the given permission code. A list of valid permission codes are found in the database table `permissions`. Note: if a user has the `ADMIN` permission, this will always return true no matter what code is requested, because the user in question should have enough system access to give themselves the permission if so desired. |`mobileenabled`| None | Returns a boolean `mobile` to indicate the value of the config setting `MOBILE_ENABLED`. | `mobilevalid` | `username`, `code` | Returns a boolean `valid` to indicate if the supplied username and mobile code are valid. +| `alertemail` | `username`, `appname` (optional) | Send alert email to system administrator regarding the specified user and application. +| `codelogin` | `code` | Validate one-time code and (if successful) return username, realname, and uid for the user who generated the code. For code generation API, see `/mobile/index.php` +| `listapps` | None | Get the list of configured apps from `settings.php` in `{"apps":{}}`. +| `getusersbygroup` | `gid`, `get` (optional) | Get all the user IDs in the specified group. If `get` equals `username`, return usernames instead of user IDs. +| `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). \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 677bc28..0df45c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# AccountHub +# AccountHub AccountHub is a web application enabling secure self-serve account management. Employees can change their password and manage other web apps they have access to with the dashboard.