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

19 أبريل 2024

ID 242752

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

طلب

الرأس:

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

النص:

  • userكائن – كائن يحتوي على معلومات شخصية عن المستخدم.
    • fullNameسلسلة نصية – الاسم الكامل للمستخدم.
    • shortNameسلسلة نصية – الاسم المختصر للمستخدم.
    • emailسلسلة نصية – عنوان البريد الإلكتروني للمستخدم. ويجب أن يكون مكتوبًا بأحرف صغيرة. وسينتج عن الإدخال مثل AdMiN@DomAn.com خطأ في التحقق من صحة الإدخال.
  • groupكائن – كائن يحتوي على معلومات عن المجموعة التي سيتم تعيين المستخدم لها.
    • idسلسلة نصية – معرّف المجموعة.

مثال على نص الطلب:

{

    user: {

        fullName: 'John Doe',

        shortName: 'John',

        email: 'some@email.com'

    },

    group: {

        id: '627d5c63f0672a10fbac23bb'

    }

}

الرد

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

مثال على رد:

{

    user: {

        id: '627b4aa62344090b598f7435'

    }

}

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

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

هل وجدت هذه المقالة مفيدة؟
ما الذي يمكننا تحسينه؟
شكرًا لك على ملاحظاتك! تساعدُنا على التحسن.
شكرًا لك على ملاحظاتك! تساعدُنا على التحسن.