Users

This guide explains how to interact with the admin manage the users crud.

Get All Users

Endpoint

• Method: GET
• URL: /v1/admin/users

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
search_text	string	User's name, email...	No	null
sort	string	User's is active	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "users": [
            {
                "id": "uuid",
                "firstName": "alaa",
                "lastName": "elyak",
                "avatar": "https://avatar.png",
                "email": "alaa.a@elyak.com",
                "role": "admin"
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Show User

Endpoint

• Method: GET
• URL: /v1/admin/users/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
     "data": {
        "id": "uuid",
        "firstName": "alaa",
        "lastName": "elyak",
        "email": "alaa.a@elyak.com",
        "avatar": "https://avatar.png",
        "role": "admin",
        "permissions": {
            "المستخدمين": [
                {
                    "id": 1,
                    "name": "coaches",
                    "nameAr": "المستشارين",
                    "children": [
                        {
                            "id": 25,
                            "name": "show_coaches",
                            "parentId": 1,
                            "nameAr": "عرض قائمة المستشارين",
                            "isActive": true,
                            "children": []
                        }
                    ]
                },
            ]
        }
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Create User

Endpoint

• Method: POST
• URL: /v1/admin/users

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
first_name	string	User's first name	Yes
last_name	string	User's last name	Yes
email	string	User's email address	Yes
password	string	User's password	Yes
password_confirmation	string	User's password confirmation	Yes
role	string	User's phone	Yes
avatar	file	User's avatar	No
clear_avatar	string	User's clear avatar	No

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
     "data": {
        "id": "uuid",
        "firstName": "alaa",
        "lastName": "elyak",
        "email": "alaa.a@elyak.com",
        "avatar": "https://avatar.png",
        "role": "admin",
        "permissions": {
            "المستخدمين": [
                {
                    "id": 1,
                    "name": "coaches",
                    "nameAr": "المستشارين",
                    "children": [
                        {
                            "id": 25,
                            "name": "show_coaches",
                            "parentId": 1,
                            "nameAr": "عرض قائمة المستشارين",
                            "isActive": true,
                            "children": []
                        }
                    ]
                },
            ]
        }
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Update User

Endpoint

• Method: PATCH
• URL: /v1/admin/users/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
first_name	string	User's first name	No
last_name	string	User's last name	No
email	string	User's email address	No
password	string	User's password	No
password_confirmation	string	User's password confirmation	No
role	string	User's phone	No
avatar	file	User's avatar	No
clear_avatar	string	User's clear avatar	No

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
     "data": {
        "id": "uuid",
        "firstName": "alaa",
        "lastName": "elyak",
        "email": "alaa.a@elyak.com",
        "avatar": "https://avatar.png",
        "role": "admin",
        "permissions": {
            "المستخدمين": [
                {
                    "id": 1,
                    "name": "coaches",
                    "nameAr": "المستشارين",
                    "children": [
                        {
                            "id": 25,
                            "name": "show_coaches",
                            "parentId": 1,
                            "nameAr": "عرض قائمة المستشارين",
                            "isActive": true,
                            "children": []
                        }
                    ]
                },
            ]
        }
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Delete User

Endpoint

• Method: DELETE
• URL: /v1/admin/users

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
ids	array	User's id	No

Success Response

{
    "success": true,
    "message": "تم حذف البيانات بنجاح.",
    "data": [],
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Update User's Password

Endpoint

• Method: PATCH
• URL: /v1/admin/update-user-password/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
send_to_mail	bool	User's send update password mail	No

Success Response

{
    "success": true,
    "message": "تمت إعادة تعيين كلمة المرور بنجاح",
    "data": {
        "password": "VnU9w&cW19"
    },
    "statusCode": 200
}