كيفية استخدام واجهة برمجة تطبيقات IoT Central REST لإدارة المستخدمين والأدوار

  • مقالة
  • قراءة خلال 2 دقائق

تتيح لك واجهة برمجة تطبيقات REST في IoT Central تطوير تطبيقات العميل التي تتكامل مع تطبيقات IoT Central. يمكنك استخدام واجهة برمجة تطبيقات REST لإدارة المستخدمين والأدوار في تطبيق IoT Central الخاص بك.

تتطلب كل مكالمة لواجهة برمجة تطبيقات IoT Central REST رأس تفويض. لمعرفة المزيد، راجع كيفية مصادقة مكالمات واجهة برمجة تطبيقات IoT Central REST وتفويضها.

للحصول على الوثائق المرجعية لواجهة برمجة تطبيقات IoT Central REST، راجع مرجع Azure IoT Central REST API.

تلميح

تتضمن واجهة برمجة تطبيقات المعاينة دعما لميزة المؤسسات الجديدة.

إدارة الأدوار

تتيح لك واجهة برمجة تطبيقات REST سرد الأدوار المحددة في تطبيق IoT Central الخاص بك. استخدم الطلب التالي لاسترداد قائمة بمعرفات الأدوار من التطبيق الخاص بك:

GET https://{your app subdomain}.azureiotcentral.com/api/roles?api-version=1.0

تبدو الاستجابة لهذا الطلب مثل المثال التالي الذي يتضمن الأدوار الثلاثة المضمنة ودورا مخصصا:

{
  "value": [
    {
      "id": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4",
      "displayName": "Administrator"
    },
    {
      "id": "ae2c9854-393b-4f97-8c42-479d70ce626e",
      "displayName": "Operator"
    },
    {
      "id": "344138e9-8de4-4497-8c54-5237e96d6aaf",
      "displayName": "Builder"
    },
    {
      "id": "16f8533f-6b82-478f-8ba8-7e676b541b1b",
      "displayName": "Example custom role"
    }
  ]
}

إدارة المستخدمين

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

  • إدراج المستخدمين في تطبيق
  • استرداد تفاصيل مستخدم فردي
  • أنشئ مجموعة
  • تعديل مستخدم
  • حذف مستخدم

قائمة المستخدمين

استخدم الطلب التالي لاسترداد قائمة بالمستخدمين من التطبيق الخاص بك:

GET https://{your app subdomain}.azureiotcentral.com/api/users?api-version=1.0

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

{
  "value": [
    {
      "id": "91907508-04fe-4349-91b5-b872f3055a95",
      "type": "email",
      "roles": [
        {
          "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
        }
      ],
      "email": "user1@contoso.com"
    },
    {
      "id": "dc1c916b-a652-49ea-b128-7c465a54c759",
      "type": "email",
      "roles": [
        {
          "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
        }
      ],
      "email": "user2@contoso.com"
    },
    {
      "id": "3ab9375e-d2d9-42da-b419-6ae86a938321",
      "type": "email",
      "roles": [
        {
          "role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
        }
      ],
      "email": "user3@contoso.com"
    },
    {
      "id": "fc5a250b-83fb-433d-892c-e0a144f68c2b",
      "type": "email",
      "roles": [
        {
          "role": "16f8533f-6b82-478f-8ba8-7e676b541b1b"
        }
      ],
      "email": "user4@contoso.com"
    }
  ]
}

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

استخدم الطلب التالي لاسترداد تفاصيل مستخدم فردي من تطبيقك:

GET https://{your app subdomain}.azureiotcentral.com/api/users/dc1c916b-a652-49ea-b128-7c465a54c759?api-version=1.0

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

{
  "id": "dc1c916b-a652-49ea-b128-7c465a54c759",
  "type": "email",
  "roles": [
    {
      "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
    }
  ],
  "email": "user2@contoso.com"
}

أنشئ مجموعة

استخدم الطلب التالي لإنشاء مستخدم في التطبيق الخاص بك. يجب أن يكون المعرف والبريد الإلكتروني فريدين في التطبيق:

PUT https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=1.0

في نص الطلب التالي، role تكون القيمة لدور المشغل الذي قمت باسترداده مسبقا:

{
  "id": "user-001",
  "type": "email",
  "roles": [
    {
      "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
    }
  ],
  "email": "user5@contoso.com"
}

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

{
  "id": "user-001",
  "type": "email",
  "roles": [
    {
      "role": "ae2c9854-393b-4f97-8c42-479d70ce626e"
    }
  ],
  "email": "user5@contoso.com"
}

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

تغيير دور مستخدم

استخدم الطلب التالي لتغيير الدور المعين للمستخدم. يستخدم هذا المثال معرف دور المنشئ الذي قمت باسترداده مسبقا:

PATCH https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=1.0

طلب الهيئة. القيمة هي لدور المنشئ الذي قمت باسترداده مسبقا:

{
  "roles": [
    {
      "role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
    }
  ]
}

تبدو الاستجابة لهذا الطلب مثل المثال التالي:

{
  "id": "user-001",
  "type": "email",
  "roles": [
    {
      "role": "344138e9-8de4-4497-8c54-5237e96d6aaf"
    }
  ],
  "email": "user5@contoso.com"
}

حذف مستخدم

استخدم الطلب التالي لحذف مستخدم:

DELETE https://{your app subdomain}.azureiotcentral.com/api/users/user-001?api-version=1.0

الخطوات التالية

الآن بعد أن تعلمت كيفية إدارة المستخدمين والأدوار باستخدام واجهة برمجة تطبيقات REST ، فإن الخطوة التالية المقترحة هي كيفية استخدام واجهة برمجة تطبيقات IoT Central REST لإدارة المؤسسات.