المستخدم

/v1/users/{username}

استخدم نقطة النهاية هذه لاسترداد حساب المستخدم أو حذفه أو تحديثه.

القراءة

احصل على معلومات حول حساب مستخدم محدد.

مثال

لاسترداد حساب مستخدم، استخدم طلب GET في نقطة النهاية /users/{username}:

GET /v1/users/username
Authorization: Bearer your-auth-token

عند نجاح الأمر، تتضمن الاستجابة رمز حالة HTTP 200 OK وحمولة بيانات مشابهة لما يلي:

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

التحديث

يمكن للمستخدم الذي يتمتع بدور ROLE_ADMIN تحديث كلمة السر المرتبطة بحسابات المستخدمين الذين يتمتعون بأدوار ROLE_ADMIN وROLE_USER. كما يمكن للمستخدمين الأفراد تحديث كلمة السر لحساباتهم الخاصة. ولا يؤدي تحديث كلمة السر لحساب المستخدم إلى إبطال أي رموز وصول مرتبطة بالمستخدم. وحاليًا، لا يتمتع مستخدم admin إلا بدور ROLE_ADMIN؛ أما المستخدمون الآخرون، فيتمتعون بدور ROLE_USER.

مثال

لتحديث كلمة السر في أحد الحسابات، يجب توفير رمز Bearer وكذلك اسم المستخدم وكلمة السر الجديدة.

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

إذا نجح الأمر، يتم تحديث كلمة السر المرتبطة باسم المستخدم. ويتم إرجاع رمز حالة HTTP 200 OK وكذلك حمولة بيانات مشابهة لما يلي:

{
   "users": [{
      "username": "username"
   }]
}

الحذف

إذا تم اختراق حساب أو إذا كانت هناك أي أسباب أخرى لحذفه، فيجب حذف الحساب بواسطة admin. وبعد حذف الحساب بنجاح، تتم إزالة جميع الرموز المميزة المرتبطة بالحساب من النظام.

مثال

استخدم استدعاء API التالي لحذف حساب المستخدم، حيث يكون username هو اسم مستخدم الحساب الذي تريد حذفه. والرمز Bearer هو الرمز الذي ينتمي إلى الحساب admin.

DELETE /v1/users/username
Authorization: Bearer your-auth-token

إذا نجح الأمر، يتم حذف حساب المستخدم. وتتضمن الاستجابة رمز حالة HTTP 200 OK وحمولة البيانات التالية:

{
   "users": [{
      "username": "username"
   }]
}

رموز الأخطاء