إدارة المسؤولين باستخدام واجهة برمجة التطبيقات Cato

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

إضافة مسؤول تكوين واجهة برمجة التطبيقات

تقوم واجهة برمجة التطبيقات لتكوين addAdmin بإنشاء مسؤولين جدد للحساب في تطبيق إدارة Cato.

إضافة مسؤول إدخال المعلمة

  • معرف الحساب (إلزامي)

إضافة مسؤول الوسيطات

هذه هي الحجج لواجهة برمجة التطبيقات لتكوين addAdmin:

  • الاسم الأول: الاسم الأول للمسؤول (بحد أقصى 255 حرفًا) - هذا الحقل إلزامي
  • الاسم الأخير: الاسم الأخير للمسؤول (بحد أقصى 255 حرفًا) - هذا الحقل إلزامي
  • البريد الإلكتروني: عنوان البريد الإلكتروني الفريد لكل مسؤول (بحد أقصى 255 حرفًا) - هذا الحقل إلزامي
  • كلمة المرور لا تنتهي صلاحيتها أبدًا: قيمة منطقية (صح/خطأ). إذا تم تعيين القيمة على صح، فلن تنتهي صلاحية كلمة مرور المسؤول أبدًا - هذا الحقل إلزامي
  • تمكين المصادقة المتعددة العوامل (MFA): قيمة منطقية (صح/خطأ). إذا تم تعيين القيمة على صح، يجب على المسؤول استخدام رمز MFA لتسجيل الدخول إلى تطبيق إدارة كاتو - هذا الحقل إلزامي
  • managedRoles: مصفوفة من updateAdminRoleInput. يحدد دورًا واحدًا أو أكثر يتم تعيينها للمسؤول. بالنسبة لمسؤولين الموزعين، يحدد هذا الحقل الأدوار المخصصة للمسؤول للحسابات المدارة. إذا لم يتم تحديد هذا الحقل لنداء API، يتم تعيين دور المشاهد (ID 2) للمسؤول

    • استخدم المعرف 1 لتعيين دور المحرر للمسؤول
  • أدوار بائع: مصفوفة من مدخلات تحديث دور المسؤول (متعلق فقط بمسؤولي البائعين). يعرف الأدوار التي تم تعيينها للمسؤول لحساب البائع. إذا لم يتم تعريف هذا الحقل لنداء واجهة برمجة التطبيقات، فقد تم تعيين دور العارض للمسؤول لحساب البائع.

بمجرد إنشاء المسؤول، يكون التدفق هو نفسه كما لو كان المسؤول قد تم إنشاؤه في تطبيق إدارة كاتو.

إذا تم تعريف الحساب للسماح للمسؤولين بتسجيل الدخول باستخدام اسم المستخدم وكلمة المرور، فسوف يتلقى المسؤول بريدًا إلكترونيًا ترحيبيًا يتضمن رابطًا لتفعيل الحساب وتعيين كلمة المرور.

image1.png

مثال على واجهة برمجة التطبيقات لإضافة مسؤول

mutation  {
  admin(accountId:"xxxxxx") {
    addAdmin(input: {
      firstName :"dani2",
      lastName :"din2"
      email: "danidin5@4catonetworks.com",
      passwordNeverExpires: true,
      mfaEnabled: false,
      managedRoles: [{ role: { id: 2} }, {role: {id:3}}]
    }) {
        adminID
    }
  }
}
image2.png
image3.png

تحديث مسؤول تكوين واجهة برمجة التطبيقات

تمكنك واجهة برمجة التطبيقات لتكوين updateAdmin من تحديث معلومات المسؤول (لا يمكن تحديث البريد الإلكتروني ومعرف المسؤول).

تحديث مسؤول إدخال المعالم

  • معرف الحساب (إلزامي)

تحديث مسؤول الوسيطات

  • معرف المسؤول (إلزامي)
  • الاسم الأول: الاسم الأول للمسؤول
  • الاسم الأخير: الاسم الأخير للمسؤول
  • كلمة المرور لا تنتهي صلاحيتها أبدًا: قيمة منطقية (صح/خطأ). إذا تم تعيين القيمة على صح، فلن تنتهي صلاحية كلمة مرور المسؤول أبدًا
  • تمكين المصادقة المتعددة العوامل (MFA): قيمة منطقية (صح/خطأ). إذا تم تعيين القيمة على صح، يجب على المسؤول استخدام رمز MFA لتسجيل الدخول إلى تطبيق إدارة كاتو
  • الأدوار المدارة: مصفوفة من updateAdminRoleInput. يحدد دور أو أكثر الذي يتم تعيينه للمسؤول. بالنسبة لمسؤولي البائعين، يحدد هذا الحقل الأدوار التي تم تعيينها للمسؤول لحسابات المدارة.
  • أدوار بائع: مصفوفة من updateAdminRoleInput (متعلق فقط بمسؤولي البائعين). يحدد الأدوار التي تم تعيينها للمسؤول لحساب البائع.

مثال على واجهة برمجة التطبيق لتحديث المسؤول

mutation {
  admin(accountId: "26") {
    updateAdmin(
      adminID: "28876"
      input: {
        firstName: "sample"
        lastName: "admin"
        passwordNeverExpires: true
        managedRoles: [{ role: { id: 1 } }]
      }
    ) {
      adminID
    }
  }
}
updateAdmin.png

إزالة مسؤول

تمكنك واجهة برمجة التطبيقات لتكوين removeAdmin من حذف مسؤول من الحساب.

إزالة مسؤول الوسائط

  • معرف الحساب (إلزامي)
  • معرف المسؤول (إلزامي)

مثال على واجهة برمجة التطبيقات لإزالة مسؤول

mutation  {
  admin(accountId:"XXX") {
    removeAdmin(adminID:YYY
    ) {
        adminID
    }
  }
}

مسؤولو واجهة برمجة المؤشر للقراءة فقط

يُرجع الاستعلام عن واجهة برمجة التطبيقات للقراءة فقط admins البيانات المتعلقة بجميع المسؤولين في الحساب، بما في ذلك: المعرف، البريد الإلكتروني، الاسم الأول، الأسم الأخير، passwordNeverExpires، mfaEnabled، والأدوار.

مسؤولو إدخال المعالم

  • معرف الحساب (إلزامي)

وسائط مسؤولو أرجومنت

  • المعرف: معرف Cato للمسؤول
  • الاسم الأول: الاسم الأول للمسؤول
  • الاسم الأخير: الاسم الأخير للمسؤول
  • البريد الإلكتروني: عنوان البريد الإلكتروني
  • كلمة المرور لا تنتهي صلاحيتها أبدًا: قيمة منطقية (صح/خطأ). إذا تم تعيين القيمة على صح، فلن تنتهي صلاحية كلمة مرور المسؤول أبدًا
  • تمكين المصادقة المتعددة العوامل (MFA): قيمة منطقية (صح/خطأ). إذا تم تعيين القيمة على صح، يجب على المسؤول استخدام رمز MFA لتسجيل الدخول إلى تطبيق إدارة كاتو
  • الأدوار المدارة: مصفوفة من updateAdminRoleInput. يحدد دور أو أكثر الذي يتم تعيينه للمسؤول. بالنسبة لمسؤولي البائعين، يحدد هذا الحقل الأدوار التي تم تعيينها للمسؤول لحسابات المدارة.
  • أدوار بائع: مصفوفة من updateAdminRoleInput (متعلق فقط بمسؤولي البائعين). يعرف الأدوار التي تم تعيينها للمسؤول لحساب البائع.

مثال على واجهة برمجة واجهة للمسؤولين

query {
  admins(accountID: XXXX) {
    items {
      id
      email
      firstName
      lastName
      modifyDate
      creationDate
      passwordNeverExpires
      mfaEnabled
      managedRoles {
        role {
          id
          name
        }
	resellerRoles {
        role {
          id
          name
        }
      }
    }
  }
}
admins.png

الحصول على تعديل مسؤول لقراءة فقط لواجهة برمجة التطبيقات

يُرجع الاستعلام عن واجهة برمجة التطبيقات للقراءة فقط getAdmin معلومات حول مسؤول حساب مفرد، مثل: البريد الإلكتروني، الاسم الأول، الاسم الأخير، passwordNeverExpires، mfaEnabled، والأدوار

الحصول على إدخال معالم مسؤول

  • معرف الحساب (إلزامي)
  • معرف المسؤول (إلزامي)

الحصول على وسيطات تعديل المسؤول

  • الاسم الأول: الاسم الأول للمسؤول
  • الاسم الأخير: الاسم الأخير للمسؤول
  • البريد الإلكتروني: عنوان البريد الإلكتروني
  • كلمة المرور لا تنتهي صلاحيتها أبدًا: قيمة منطقية (صح/خطأ). إذا تم تعيينها على صح، فلن تنتهي صلاحية كلمة مرور المسؤول أبدًا
  • تمكين المصادقة المتعددة العوامل (MFA): قيمة منطقية (صح/خطأ). إذا تم تعيينها على صح، يجب على المسؤول استخدام رمز MFA لتسجيل الدخول إلى تطبيق إدارة كاتو
  • الأدوار المدارة: مصفوفة من updateAdminRoleInput. يحدد دور أو أكثر الذي يتم تعيينه للمسؤول. بالنسبة لمسؤولي البائعين، يحدد هذا الحقل الأدوار التي تم تعيينها للمسؤول لحسابات المدارة.
  • أدوار بائع: مصفوفة من updateAdminRoleInput (متعلق فقط بمسؤولي البائعين). يعرف الأدوار التي تم تعيينها للمسؤول لحساب البائع.

مثال على واجهة برمجة التطبيقات للحصول على المسؤول

query {
  getAdmin(accountId: "XXX", adminID: YYY) {
    id
    firstName
    lastName
    email
    passwordNeverExpires
    mfaEnabled
    creationDate
    managedRoles {
      role {
        id
        name
      }
    }
    resellerRoles {
      role {
        id
        name
      }
    }
  }
}
getAdmin.png

أدوار الحساب لواجهة برمجة التطبيقات لقراءة فقط

يعيد الاستعلام عن واجهة برمجة التطبيقات للقراءة فقط accountRoles جميع الأدوار المحددة للحساب (سواء الأدوار المخصصة أو المعرفة مسبقًا). يتطلب للعملاء الذين يستخدمون واجهة برمجة التطبيقات addAdmin، لأن هذه الواجهة تظهر معرفات الأدوار (يستخدمها addAdmin API).

إدخال معالم أدوار الحساب

  • معرف الحساب
  • accountType

    • العادي (للأدوار العادية أو حسابات المدارة)
    • بائع (للأدوار حسابات البائع)

وسائط أدوار الحساب

   المعرف: معرف ID! (معرف الدور)
   الاسم: نص! (اسم الدور)
   الوصف: نص (الوصف)
   معرفة مسبقة: منطقية! (هل هي دور معرف مسبقًا أو مخصص)
image4.png

مثال استعلام أدوار الحساب

طلب{
  accountRoles(accountID:XXX, accountType:REGULAR)
  {
    items
    {
      id
      name
      isPredefined
      description
    }
    total
  }
}

تحديث تكوين واجهة برمجة التطبيقات لـ updateAdminRoleInput

تمكنك واجهة برمجة التطبيقات لتكوين updateAdminRoleInput من تحديث الإعدادات لدور المسؤول لتطبيق إدارة Cato.

إدخال updateAdminRoleInput {
  الدور: updateAccountRoleInput!
  الكيانات المسموح بها: [entityInput!]
}

هل كان هذا المقال مفيداً؟

0 من 0 وجدوا هذا مفيداً

لا توجد تعليقات