SCIM API 2.0 (المستخدمين)

هام

هذه الميزة في المعاينة العامة.

يمكن لمسؤول Azure Databricks استدعاء كافة نقاط نهاية API SCIM. يمكن للمستخدمين غير المسؤول استدعاء نقطة النهاية الحصول على المستخدمين لقراءة أسماء عرض المستخدمين و معرفات.

ملاحظة

يمكن أن يكون لكل مساحة عمل 10,000 مستخدم كحد أقصى و5,000 مجموعة. يتم احتساب أساسيات الخدمة في أقصى حد للمستخدم.

يتيح لك SCIM (المستخدمون) إنشاء مستخدمين في Azure Databricks ومنحهم المستوى المناسب من الوصول ، وتأمين حسابات المستخدمين وإلغاء قفلها مؤقتا ، وإزالة وصول المستخدمين (ديبروفيسيون لهم) عندما يغادرون مؤسستك أو لا يحتاجون إلى الوصول إلى Azure Databricks.

المتطلبات

يجب أن يكون حساب Azure Databricks خطة Premium Azure Databricks.

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

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users GET

المستخدمين المسؤول: استرداد قائمة بكافة المستخدمين في مساحة عمل Azure Databricks.

المستخدمين غير الإداريين: استرداد قائمة بكافة المستخدمين في مساحة عمل Azure Databricks، وإرجاع اسم المستخدم، واسم عرض المستخدم، و معرف الكائن فقط.

أمثلة

يحصل هذا المثال على معلومات حول كافة المستخدمين.

curl --netrc -X GET \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users \
| jq .

يستخدم هذا المثال eq المعلمة (يساوي) استعلام eq مع userName للحصول على معلومات حول مستخدم معين.

curl --netrc -X GET \
"https://<databricks-instance>/api/2.0/preview/scim/v2/Users?filter=userName+eq+<username>" \
| jq .

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <username> باستخدام اسم مستخدم مساحة عمل Azure Databricks للمستخدم، على سبيل المثال someone@example.com .

يستخدم هذا المثال ملف .netrc و jq.

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

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users/{id} GET

المستخدمين المسؤول: استرداد مورد مستخدم واحد من مساحة عمل Azure Databricks، نظرا لمع معرفات البيانات Azure الخاصة بهم.

مثال

طلب

curl --netrc -X GET \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
| jq .

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <user-id> باستخدام معرف مساحة عمل Azure Databricks للمستخدم، على سبيل المثال 2345678901234567 . للحصول على معرف المستخدم، اتصل بالحصول على المستخدمين.

يستخدم هذا المثال ملف .netrc و jq.

الاستجابة

إنشاء مستخدم

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users POST

المستخدمين المسؤول: إنشاء مستخدم في مساحة عمل Azure Databricks.

معلمات الطلب اتبع بروتوكول SCIM 2.0 القياسي.

يجب أن تتضمن الطلبات السمات التالية:

  • schemasتعيين إلى urn:ietf:params:scim:schemas:core:2.0:User
  • userName

مثال

curl --netrc -X POST \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users \
--header 'Content-type: application/scim+json' \
--data @create-user.json \
| jq .

create-user.json:

{
  "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "userName": "<username>",
  "groups": [
    {
       "value":"123456"
    }
  ],
  "entitlements":[
    {
       "value":"allow-cluster-create"
    }
  ]
}

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <username> باستخدام اسم مستخدم مساحة عمل Azure Databricks للمستخدم، على سبيل المثال someone@example.com .

يستخدم هذا المثال ملف .netrc و jq.

تحديث المستخدم حسب معرف ( PATCH )

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users/{id} PATCH

المستخدمين المسؤول: تحديث مورد مستخدم مع عمليات على سمات معينة، باستثناء تلك التي هي ثابتة ( userName و userId ). PATCHيوصى باستخدام الأسلوب عبر PUT طريقة إعداد أو تحديث استحقاقات المستخدم.

معلمات الطلب اتبع بروتوكول 2.0 SCIM القياسية وتعتمد على قيمة schemas السمة.

مثال

يضيف هذا المثال allow-cluster-create الاستحقاق إلى المستخدم المحدد.

curl --netrc -X PATCH \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
--header 'Content-type: application/scim+json' \
--data @update-user.json \
| jq .

update-user.json:

{
  "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ],
  "Operations": [
    {
      "op": "add",
      "path": "entitlements",
      "value": [
        {
           "value": "allow-cluster-create"
        }
      ]
    }
  ]
}

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <user-id> باستخدام معرف مساحة عمل Azure Databricks للمستخدم، على سبيل المثال 2345678901234567 . للحصول على معرف المستخدم، اتصل بالحصول على المستخدمين.

يستخدم هذا المثال ملف .netrc و jq.

تحديث المستخدم حسب معرف ( PUT )

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users/{id} PUT

المستخدمين المسؤول: الكتابة فوق مورد المستخدم عبر سمات متعددة، باستثناء تلك التي هي ثابتة ( userName و userId ).

يجب أن يتضمن الطلب schemas السمة، تعيين إلى urn:ietf:params:scim:schemas:core:2.0:User .

ملاحظة

PATCHيوصى باستخدام الأسلوب عبر PUT طريقة إعداد أو تحديث استحقاقات المستخدم.

مثال

يغير هذا المثال الاستحقاقات السابقة للمستخدم المحدد إلى الآن فقط allow-cluster-create الاستحقاق.

curl --netrc -X PUT \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
--header 'Content-type: application/scim+json' \
--data @overwrite-user.json \
| jq .

overwrite-user.json:

{
  "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  "userName": "<username>",
  "entitlements": [
    {
      "value": "allow-cluster-create"
    }
  ]
}

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <user-id> باستخدام معرف مساحة عمل Azure Databricks للمستخدم، على سبيل المثال 2345678901234567 . للحصول على معرف المستخدم، اتصل بالحصول على المستخدمين.
  • <username> باستخدام اسم مستخدم مساحة عمل Azure Databricks للمستخدم، على سبيل المثال someone@example.com . للحصول على اسم المستخدم، اتصل بالحصول على المستخدمين.

يستخدم هذا المثال ملف .netrc و jq.

حذف المستخدم حسب معرف

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users/{id} DELETE

المستخدمين المسؤول: إزالة مورد مستخدم. يتم تلقائيا إزالة مستخدم لا يملك أو ينتمي إلى مساحة عمل في Azure Databricks بعد 30 يوما.

يؤدي حذف مستخدم من مساحة عمل أيضا إلى إزالة الكائنات المقترنة بالمستخدم. على سبيل المثال، يتم أرشفة دفاتر الملاحظات، إنهاء الكتل، وتصبح المهام بلا مالك.

لا يتم حذف الدليل الرئيسي للمستخدم تلقائيا. يمكن للمسؤول فقط الوصول إلى الدليل الرئيسي للمستخدم المحذوف أو إزالته.

طلب مثال

curl --netrc -X DELETE \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id>

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <user-id> باستخدام معرف مساحة عمل Azure Databricks للمستخدم، على سبيل المثال 2345678901234567 . للحصول على معرف المستخدم، اتصل بالحصول على المستخدمين.

يستخدم هذا المثال ملف .netrc.

تنشيط المستخدم وتعطيله حسب معرف

هام

هذه الميزة في المعاينة العامة.

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users/{id} PATCH

مستخدمو المسؤول: تنشيط مستخدم أو إلغاء تنشيطه. إلغاء تنشيط مستخدم إزالة كافة الوصول إلى مساحة عمل لهذا المستخدم ولكن يترك الأذونات والكائنات المقترنة بالمستخدم دون تغيير. تستمر المجموعات المقترنة بالمستخدم في العمل، وتظل دفاتر الملاحظات في مواقعها الأصلية. يتم الاحتفاظ بالرموز المميزة للمستخدم ولكن لا يمكن استخدامها للمصادقة أثناء إلغاء تنشيط المستخدم. ومع ذلك، تفشل المهام المجدولة ما لم يتم تعيينها إلى مالك جديد.

يمكنك استخدام طلبات الحصول على المستخدمينوالحصول على المستخدم حسب معرف لعرض ما إذا كان المستخدمون نشطين أو غير نشطين.

ملاحظة

السماح بخمس دقائق على الأقل لمسح ذاكرة التخزين المؤقت حتى يصبح التعطيل نافذ المفعول.

هام

يمكن لمستخدم Azure Active Directory (Azure AD) الذي له دور المساهم أو المالك على اشتراك Azure Databricks إعادة تنشيط نفسه باستخدام تدفق تسجيل الدخول إلى Azure AD. إذا كان المستخدم الذي لديه أحد هذه الأدوار بحاجة إلى إلغاء تنشيطه، فيجب عليك أيضا إلغاء امتيازاته في الاشتراك.

تعيين القيمة false النشطة لإلغاء تنشيط مستخدم true وتنشيط مستخدم.

مثال

طلب

curl --netrc -X PATCH \
https://<databricks-instance>/api/2.0/preview/scim/v2/Users/<user-id> \
--header 'Content-type: application/scim+json' \
--data @toggle-user-activation.json \
| jq .

toggle-user-activation.json:

{
  "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ],
  "Operations": [
    {
      "op": "replace",
      "path": "active",
      "value": [
        {
          "value": "false"
        }
      ]
    }
  ]
}

استبدال:

  • <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .
  • <user-id> باستخدام معرف مساحة عمل Azure Databricks للمستخدم، على سبيل المثال 2345678901234567 .

يستخدم هذا المثال ملف .netrc و jq.

الاستجابة

{
  "emails": [
    {
      "type": "work",
      "value": "someone@example.com",
      "primary": true
    }
  ],
  "displayName": "Someone User",
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:workspace:2.0:User"
  ],
  "name": {
    "familyName": "User",
    "givenName": "Someone"
  },
  "active": false,
  "groups": [],
  "id": "123456",
  "userName": "someone@example.com"
}

تصفية المستخدمين النشطين وغير النشطين

هام

هذه الميزة في المعاينة العامة.

نقطة النهاية أسلوب HTTP
2.0/preview/scim/v2/Users GET

المستخدمين المسؤول: استرداد قائمة من المستخدمين النشطين أو غير النشطين.

مثال

curl --netrc -X GET \
"https://<databricks-instance>/api/2.0/preview/scim/v2/Users?filter=active+eq+false" \
| jq .

استبدال <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .

يستخدم هذا المثال ملف .netrc و jq.

إلغاء تنشيط المستخدمين تلقائيا

هام

هذه الميزة في المعاينة العامة.

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

نقطة النهاية أسلوب HTTP
2.0/preview/workspace-conf PATCH

نص الطلب هو زوج قيمة مفتاح حيث القيمة هي الحد الزمني لفترة المستخدم يمكن أن تكون غير نشطة قبل أن يتم إلغاء تنشيط تلقائيا.

مثال

curl --netrc -X PATCH \
https://<databricks-instance>/api/2.0/preview/workspace-conf \
--data @deactivate-users.json \
| jq .

deactivate-users.json:

{
  "maxUserInactiveDays": "90"
}

استبدال <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .

يستخدم هذا المثال ملف .netrc و jq.

الحصول على الحد الأقصى لفترة عدم نشاط المستخدم لمساحة العمل

هام

هذه الميزة في المعاينة العامة.

المستخدمين المسؤول: استرداد حد عدم نشاط المستخدم المعرفة لمساحة عمل.

نقطة النهاية أسلوب HTTP
2.0/preview/workspace-conf GET

طلب مثال

curl --netrc -X GET \
"https://<databricks-instance>/api/2.0/preview/workspace-conf?keys=maxUserInactiveDays" \
| jq .

استبدال <databricks-instance><databricks-instance>Azure Databricks ، على سبيل المثال adb-1234567890123456.7.azuredatabricks.net .

يستخدم هذا المثال ملف .netrc و jq.

مثال على الاستجابة

{
  "maxUserInactiveDays": "90"
}