[PR #3238] [MERGED] User Management API #6157

New Issue

OVERLORD · 2026-02-05T10:25:48+03:00

OVERLORD commented

2026-02-05 10:25:48 +03:00

📋 Pull Request Information

Original PR: https://github.com/BookStackApp/BookStack/pull/3238
Author: @ssddanbrown
Created: 2/3/2022
Status: ✅ Merged
Merged: 2/8/2022
Merged by: @ssddanbrown

Base: development ← Head: users_api

📝 Commits (9)

0762666 Test API Endpoint for users
4cbd1a9 Extend /users API endpoint
8d7febe Merge branch 'api-endpoint-users' into users_api
d089623 Refactored existing user API work
2cd7a48 Added users-delete API endpoint
9e1c8ec Added user-update API endpoint
eb653bd Added user-create API endpoint
46e6e23 Added user API examples
c8be6ee Addressed test failures from users API changes

📊 Changes

31 files changed (+810 additions, -180 deletions)

View changed files

📝 app/Api/ApiDocsGenerator.php (+28 -1)
📝 app/Api/ListingResponseBuilder.php (+24 -3)
📝 app/Auth/Access/Guards/LdapSessionGuard.php (+1 -1)
📝 app/Auth/Access/RegistrationService.php (+2 -1)
📝 app/Auth/Role.php (+2 -0)
📝 app/Auth/User.php (+1 -1)
📝 app/Auth/UserRepo.php (+111 -34)
📝 app/Console/Commands/CreateAdmin.php (+1 -2)
📝 app/Console/Commands/DeleteUsers.php (+3 -6)
📝 app/Exceptions/Handler.php (+4 -0)
📝 app/Exceptions/NotifyException.php (+16 -1)
📝 app/Http/Controllers/Api/ApiController.php (+6 -2)
➕ app/Http/Controllers/Api/UserApiController.php (+164 -0)
📝 app/Http/Controllers/Controller.php (+3 -9)
📝 app/Http/Controllers/UserController.php (+28 -112)
📝 app/Providers/AuthServiceProvider.php (+1 -0)
➕ dev/api/requests/users-create.json (+7 -0)
➕ dev/api/requests/users-delete.json (+3 -0)
➕ dev/api/requests/users-update.json (+7 -0)
➕ dev/api/responses/users-create.json (+19 -0)

...and 11 more files

📄 Description

Continuation of #2734.
Addresses #2701 and likely #1363.

Progress

Create
Read
Update
Delete
Listing
Testing Coverage
API Examples Added

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/BookStackApp/BookStack/pull/3238 **Author:** [@ssddanbrown](https://github.com/ssddanbrown) **Created:** 2/3/2022 **Status:** ✅ Merged **Merged:** 2/8/2022 **Merged by:** [@ssddanbrown](https://github.com/ssddanbrown) **Base:** `development` ← **Head:** `users_api` --- ### 📝 Commits (9) - [`0762666`](https://github.com/BookStackApp/BookStack/commit/07626669dad962856e52dddeacb1a9f000f93150) Test API Endpoint for users - [`4cbd1a9`](https://github.com/BookStackApp/BookStack/commit/4cbd1a9eb526bcd5fe5d9446dbf27c5813042678) Extend /users API endpoint - [`8d7febe`](https://github.com/BookStackApp/BookStack/commit/8d7febe482f92a34093127c60c6e2dda342b4223) Merge branch 'api-endpoint-users' into users_api - [`d089623`](https://github.com/BookStackApp/BookStack/commit/d089623aac6b39641a0ff610c124cb3a01609efd) Refactored existing user API work - [`2cd7a48`](https://github.com/BookStackApp/BookStack/commit/2cd7a48044ede60c487bbe575fc20ed99c702571) Added users-delete API endpoint - [`9e1c8ec`](https://github.com/BookStackApp/BookStack/commit/9e1c8ec82aa856d2f17a07b9f16e9e4cafe1e073) Added user-update API endpoint - [`eb653bd`](https://github.com/BookStackApp/BookStack/commit/eb653bda16f2f1e82e5e0f0a047d63871f0b9389) Added user-create API endpoint - [`46e6e23`](https://github.com/BookStackApp/BookStack/commit/46e6e239dc644b6949e6609c27339c62a84bc711) Added user API examples - [`c8be6ee`](https://github.com/BookStackApp/BookStack/commit/c8be6ee8a6be840e8573309b8505fb53e9a9982c) Addressed test failures from users API changes ### 📊 Changes **31 files changed** (+810 additions, -180 deletions) <details> <summary>View changed files</summary> 📝 `app/Api/ApiDocsGenerator.php` (+28 -1) 📝 `app/Api/ListingResponseBuilder.php` (+24 -3) 📝 `app/Auth/Access/Guards/LdapSessionGuard.php` (+1 -1) 📝 `app/Auth/Access/RegistrationService.php` (+2 -1) 📝 `app/Auth/Role.php` (+2 -0) 📝 `app/Auth/User.php` (+1 -1) 📝 `app/Auth/UserRepo.php` (+111 -34) 📝 `app/Console/Commands/CreateAdmin.php` (+1 -2) 📝 `app/Console/Commands/DeleteUsers.php` (+3 -6) 📝 `app/Exceptions/Handler.php` (+4 -0) 📝 `app/Exceptions/NotifyException.php` (+16 -1) 📝 `app/Http/Controllers/Api/ApiController.php` (+6 -2) ➕ `app/Http/Controllers/Api/UserApiController.php` (+164 -0) 📝 `app/Http/Controllers/Controller.php` (+3 -9) 📝 `app/Http/Controllers/UserController.php` (+28 -112) 📝 `app/Providers/AuthServiceProvider.php` (+1 -0) ➕ `dev/api/requests/users-create.json` (+7 -0) ➕ `dev/api/requests/users-delete.json` (+3 -0) ➕ `dev/api/requests/users-update.json` (+7 -0) ➕ `dev/api/responses/users-create.json` (+19 -0) _...and 11 more files_ </details> ### 📄 Description Continuation of #2734. Addresses #2701 and likely #1363. ### Progress - [x] Create - [x] Read - [x] Update - [x] Delete - [x] Listing - [x] Testing Coverage - [x] API Examples Added --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

OVERLORD added the pull-request label 2026-02-05 10:25:48 +03:00

OVERLORD closed this issue

2026-02-05 10:25:52 +03:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#6157