طريقة "POST /openapi/v1/users"

إنشاء مستخدم تمت إضافته إلى مجموعة محددة.

طلب

الرأس:

• المصادقة – الرمز المميز لواجهة برمجة التطبيقات الخاصة بالشركة.

النص:

• user – كائن – كائن يحتوي على معلومات شخصية عن المستخدم.
  • fullName – سلسلة نصية – الاسم الكامل للمستخدم.
  • shortName – سلسلة نصية – الاسم المختصر للمستخدم.
  • email – سلسلة نصية – عنوان البريد الإلكتروني للمستخدم.
• group – كائن – كائن يحتوي على معلومات عن المجموعة التي سيتم تعيين المستخدم لها.
  • id – سلسلة نصية – معرّف المجموعة.

مثال على نص الطلب: { user: { fullName: 'John Doe', shortName: 'John', email: 'some@email.com' }, group: { id: '627d5c63f0672a10fbac23bb' } }

الرد

• user – كائن – كائن يتضمن معلومات عن المستخدم الذي تم إنشاؤه.
  • id – سلسلة نصية – معرّف المستخدم.

مثال على رد: { user: { id: '627b4aa62344090b598f7435' } }

الأخطاء المحتملة:

• 400 – common-validation – حدث خطأ في التحقق من صحة الطلب.
• 401 – common-unauthorized – حدث خطأ في المصادقة.
• 402 – no-available-license – لا توجد تراخيص كافية لتعيين المستخدم لمجموعة بدأ تدريبها.
• 404 – group-does-not-exists – لا تمتلك هذه الشركة مجموعة بالمعرف المشار إليه.
• 429 – too-many-requests – كان هناك الكثير من الطلبات.
• 409 – user-email-already-exists-in-company – لدى هذه الشركة بالفعل مستخدم بعنوان البريد الإلكتروني المشار إليه.

إلى أعلى الصفحة