User
This section covers the API endpoints for managing users in the admin panel.
List Users
GET /v1/admin/users
Returns a paginated list of all users.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
search_text | string | Search users by username, email, first name, last name or country name |
filter[role] | string | Filter by user role |
filter[trashed] | boolean | Include trashed users |
sort | string | Sort by field (prefix with - for descending) |
per_page | integer | Number of items per page. Defaults to 10 |
list | boolean | Return simplified list format |
Response
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"current_page": 1,
"first_page_url": "http://testing-api.sumaya369.net/v1/admin/users?search_text=aalbaiti&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://testing-api.sumaya369.net/v1/admin/users?search_text=aalbaiti&page=1",
"links": [
{
"url": null,
"label": "« السابق",
"active": false
},
{
"url": "http://testing-api.sumaya369.net/v1/admin/users?search_text=aalbaiti&page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "التالي »",
"active": false
}
],
"next_page_url": null,
"path": "http://testing-api.sumaya369.net/v1/admin/users",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1,
"users": [
{
"id": "982f2170-c0ab-3988-97b5-a96cbe983f77",
"username": "hintz.christa",
"first_name": "جعفر",
"last_name": "الكردي",
"email": "aalbaiti360@gmail.com - ",
"avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
"role": "super_admin"
}
]
},
"status_code": 200
}
Create User
POST /v1/admin/users
Create a new user.
Request Body
| Parameter | Type | Description |
|---|---|---|
username | string | Required. Username (3-16 characters) |
first_name | string | Required. First name (3-32 characters, alpha only) |
last_name | string | Required. Last name (3-32 characters, alpha only) |
email | string | Required. Valid email address (3-64 characters) |
password | string | Required. Password (5-32 characters) |
password_confirmation | string | Required. Must match password |
gender | string | Required. Either 'FEMALE' or 'MALE' |
birth | string | Required. Date format: Y-m-d (must be 13+ years old) |
phone | string | Required. Phone number (5-15 digits) |
country_id | string | Required. Valid country ID |
avatar | file | Optional. Image file (jpeg/png/jpg, 25KB-1MB) |
role | string | Required. Valid role name (3-32 characters) |
Response
{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "671e1930-07f2-11f0-9308-1375c5c8dc37",
"username": "omar alakbaris",
"first_name": "Omar",
"last_name": "ALakbri",
"email": "admin2@admin.com",
"gender": "ذكر",
"birth_day": "2007-01-01",
"phone": "734598721",
"country_id": "96935556-d930-455a-8099-98c9dbd6ee70",
"country": "قطر",
"avatar": "https://i.ibb.co/g4BR50S/avatar.png",
"role": "super_admin",
"permissions": [
"حظر مستخدم من دخول النظام",
"عرض المستخدمين",
"إضافة وتعديل وحذف المستخدمين",
"حظر العملاء من التعليق",
"عرض العملاء",
"إضافة وتعديل وحذف العملاء",
"عرض الأوسمة و التصنيفات",
"إضافة وتعديل وحذف الأوسمة و التصنيفات",
"عرض المواد والباقات و الكتب الإلكترونية",
"إضافة وتعديل وحذف المواد والباقات و الكتب الإلكترونية",
"عرض المقالات الإصدارات",
"إضافة وتعديل وحذف المقالات و الإصدارات",
"عرض التقييمات والمفضلات و التعليقات",
"قبول وحظر وحذف التقييمات و التعليقات",
"الرد على تقييمات و تعليقات العملاء",
"عرض التخفيضات",
"إضافة و تعديل وحذف التخفيضات",
"عرض الطلبات",
"تعديل الطلبات",
"عرض الإشتراكات",
"إضافة و تعديل وحذف الإشتراكات",
"عرض الأسئلة الشائعة والإعدادات",
"تعديل الإعدادات",
"حذف وتعديل وإضافة الأسئلة الشائعة",
"عرض المسوقين",
"انشاء سند استلام",
"عرض قائمة الاهداءات",
"نقل الى فئة خاصة",
"عرض احداث وخلفيات الشهر",
"تعديل وحذف احداث وخلفيات الشهر",
"عرض قائمة تصنيفات الأسئلة الشائعة ",
"إضافة وحذف وتعديل تصنيفات الأسئلة الشائعة",
"عرض قائمة التحكم في الإشعارات",
"إضافة وحذف وتعديل إشعار",
"عرض قائمة الفئة الخاصة",
" حذف وتعديل على البيانات",
" عرض قائمة النقاط",
"إضافة نقاط للعميل",
"عرض قائمة السجلات",
"مراجعة ومشاهدة السجلات",
" عرض قائمة عناصر السلة",
"عرض الصفحات",
"اضافة والتعديل على الصفحات",
" عرض قائمة الترويج",
"إضافة وتعديل وحذف ترويج"
]
},
"status_code": 200
}
Get User
GET /v1/admin/users/{id}
Retrieve details of a specific user.
Response
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"id": "982f2170-c0ab-3988-97b5-a96cbe983f77",
"username": "hintz.christa",
"first_name": "جعفر",
"last_name": "الكردي",
"email": "aalbaiti360@gmail.com",
"gender": "ذكر",
"birth_day": "2024-04-21",
"phone": "966552722736",
"country_id": "afce9d3a-30cd-4a93-adef-59e2ed1a5844",
"country": "غامبيا",
"avatar": "https://i.ibb.co/g4BR50S/avatar.png",
"role": "super_admin",
"permissions": [
"حظر مستخدم من دخول النظام",
"عرض المستخدمين",
"إضافة وتعديل وحذف المستخدمين",
"حظر العملاء من التعليق",
"عرض العملاء",
"إضافة وتعديل وحذف العملاء",
"عرض الأوسمة و التصنيفات",
"إضافة وتعديل وحذف الأوسمة و التصنيفات",
"عرض المواد والباقات و الكتب الإلكترونية",
"إضافة وتعديل وحذف المواد والباقات و الكتب الإلكترونية",
"عرض المقالات الإصدارات",
"إضافة وتعديل وحذف المقالات و الإصدارات",
"عرض التقييمات والمفضلات و التعليقات",
"قبول وحظر وحذف التقييمات و التعليقات",
"الرد على تقييمات و تعليقات العملاء",
"عرض التخفيضات",
"إضافة و تعديل وحذف التخفيضات",
"عرض الطلبات",
"تعديل الطلبات",
"عرض الإشتراكات",
"إضافة و تعديل وحذف الإشتراكات",
"عرض الأسئلة الشائعة والإعدادات",
"تعديل الإعدادات",
"حذف وتعديل وإضافة الأسئلة الشائعة",
"عرض المسوقين",
"انشاء سند استلام",
"عرض قائمة الاهداءات",
"نقل الى فئة خاصة",
"عرض احداث وخلفيات الشهر",
"تعديل وحذف احداث وخلفيات الشهر",
"عرض قائمة تصنيفات الأسئلة الشائعة ",
"إضافة وحذف وتعديل تصنيفات الأسئلة الشائعة",
"عرض قائمة التحكم في الإشعارات",
"إضافة وحذف وتعديل إشعار",
"عرض قائمة الفئة الخاصة",
" حذف وتعديل على البيانات",
" عرض قائمة النقاط",
"إضافة نقاط للعميل",
"عرض قائمة السجلات",
"مراجعة ومشاهدة السجلات",
" عرض قائمة عناصر السلة",
"عرض الصفحات",
"اضافة والتعديل على الصفحات",
" عرض قائمة الترويج",
"إضافة وتعديل وحذف ترويج"
]
},
"status_code": 200
}
Update User
PATCH /v1/admin/users/{id}
Update an existing user.
Request Body
| Parameter | Type | Description |
|---|---|---|
username | string | Optional. Username (3-16 characters) |
first_name | string | Optional. First name (3-32 characters, alpha only) |
last_name | string | Optional. Last name (3-32 characters, alpha only) |
email | string | Optional. Valid email address (3-64 characters) |
password | string | Optional. Password (5-32 characters) |
password_confirmation | string | Required if password is provided |
gender | string | Optional. Either 'FEMALE' or 'MALE' |
birth | string | Optional. Date format: Y-m-d (must be 13+ years old) |
phone | string | Optional. Phone number (5-15 digits) |
country_id | string | Optional. Valid country ID |
avatar | file | Optional. Image file (jpeg/png/jpg, 25KB-1MB) |
role | string | Optional. Valid role name (3-32 characters) |
Response
{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": {
"id": "671e1930-07f2-11f0-9308-1375c5c8dc37",
"username": "omar alakbaris",
"first_name": "Ahmcdccccv",
"last_name": "Moh",
"email": "admin2@admin.com",
"gender": "ذكر",
"birth_day": "2007-01-01",
"phone": "734598721",
"country_id": "96935556-d930-455a-8099-98c9dbd6ee70",
"country": "قطر",
"avatar": "https://i.ibb.co/g4BR50S/avatar.png",
"role": "super_admin",
"permissions": [
"حظر مستخدم من دخول النظام",
"عرض المستخدمين",
"إضافة وتعديل وحذف المستخدمين",
"حظر العملاء من التعليق",
"عرض العملاء",
"إضافة وتعديل وحذف العملاء",
"عرض الأوسمة و التصنيفات",
"إضافة وتعديل وحذف الأوسمة و التصنيفات",
"عرض المواد والباقات و الكتب الإلكترونية",
"إضافة وتعديل وحذف المواد والباقات و الكتب الإلكترونية",
"عرض المقالات الإصدارات",
"إضافة وتعديل وحذف المقالات و الإصدارات",
"عرض التقييمات والمفضلات و التعليقات",
"قبول وحظر وحذف التقييمات و التعليقات",
"الرد على تقييمات و تعليقات العملاء",
"عرض التخفيضات",
"إضافة و تعديل وحذف التخفيضات",
"عرض الطلبات",
"تعديل الطلبات",
"عرض الإشتراكات",
"إضافة و تعديل وحذف الإشتراكات",
"عرض الأسئلة الشائعة والإعدادات",
"تعديل الإعدادات",
"حذف وتعديل وإضافة الأسئلة الشائعة",
"عرض المسوقين",
"انشاء سند استلام",
"عرض قائمة الاهداءات",
"نقل الى فئة خاصة",
"عرض احداث وخلفيات الشهر",
"تعديل وحذف احداث وخلفيات الشهر",
"عرض قائمة تصنيفات الأسئلة الشائعة ",
"إضافة وحذف وتعديل تصنيفات الأسئلة الشائعة",
"عرض قائمة التحكم في الإشعارات",
"إضافة وحذف وتعديل إشعار",
"عرض قائمة الفئة الخاصة",
" حذف وتعديل على البيانات",
" عرض قائمة النقاط",
"إضافة نقاط للعميل",
"عرض قائمة السجلات",
"مراجعة ومشاهدة السجلات",
" عرض قائمة عناصر السلة",
"عرض الصفحات",
"اضافة والتعديل على الصفحات",
" عرض قائمة الترويج",
"إضافة وتعديل وحذف ترويج"
]
},
"status_code": 200
}
Get User Statistics
GET /v1/admin/statistics/users/
Returns statistics about users in the system.
Response
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"total_users": "24"
},
"status_code": 200
}
Delete Users
DELETE /v1/admin/users
Delete one or more users.
Request Body
| Parameter | Type | Description |
|---|---|---|
ids | array | Required. Array of user UUIDs to delete |
ids.* | string | Required. UUID format |
Response
{
"success": true,
"message": "تم حذف البيانات بنجاح.",
"data": null,
"status_code": 200
}
Update User Password
PATCH /v1/admin/update-user-password/{id}/
Update a user's password. If no password is provided, a random 10-character password will be generated and sent to the user's email.
Request Body
| Parameter | Type | Description |
|---|---|---|
password | string | Optional. New password (min 6 characters) |
Response
{
"success": true,
"message": "تمت إعادة تعيين كلمة المرور بنجاح",
"data": null,
"status_code": 200
}
Authorization
All user management endpoints require admin authorization. The user must have the appropriate permissions to perform these operations.
Notes
- Username and email must be unique across all users
- First name and last name must contain only alphabetic characters
- Birth date must be for users 13 years or older
- Password changes will trigger an email notification to the user
- Avatar images must be between 25KB and 1MB in size