> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# توفير SCIM

> أتمتة إدارة دورة حياة المستخدم والمجموعة باستخدام SCIM 2.0.

تدعم Truthlocks SCIM 2.0 لتوفير المستخدمين الآلي وإدارة المجموعات. قم بربط موفر الهوية الخاص بك (Okta، Azure AD، OneLogin، إلخ) لإنشاء المستخدمين وتحديثهم وإلغاء تنشيطهم تلقائيًا في مستأجر Truthlocks الخاص بك.

> [!NOTE]
>
> يتوفر توفير SCIM في خطة **Business** وما فوق.

## كيف يعمل

**1. إنشاء رمز SCIM**

في وحدة التحكم، انتقل إلى **الإعدادات > SCIM** وأنشئ رمزًا مميزًا للحامل.
يصادق هذا الرمز طلبات SCIM الخاصة بموفر الهوية الخاص بك.

**2. تكوين IdP الخاص بك**

في موفر الهوية الخاص بك، قم بتعيين عنوان URL الأساسي لـ SCIM إلى
`https://api.truthlocks.com/scim/v2` والصق رمز الحامل.

**3. مزامنة المستخدمين والمجموعات**

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

## عنوان URL الأساسي لـ SCIM

```text theme={null}
https://api.truthlocks.com/scim/v2
```

يجب أن تتضمن جميع طلبات SCIM رمز Bearer في رأس `Authorization`:

```bash theme={null}
curl -X GET https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here"
```

## العمليات المدعومة

### المستخدمون

| العملية | الطريقة | المسار | الوصف |
| - | - | - | - |
| قائمة | GET | `/scim/v2/Users` | قائمة المستخدمين مع عامل تصفية اختياري |
| إنشاء | POST | `/scim/v2/Users` | توفير مستخدم جديد |
| الحصول | GET | `/scim/v2/Users/{id}` | استرداد مستخدم بواسطة معرف SCIM |
| استبدال | PUT | `/scim/v2/Users/{id}` | استبدال المستخدم بالكامل |
| تصحيح | PATCH | `/scim/v2/Users/{id}` | تحديث جزئي (مثل إلغاء التنشيط) |
| حذف | DELETE | `/scim/v2/Users/{id}` | تعليق المستخدم |

### المجموعات

| العملية | الطريقة | المسار | الوصف |
| - | - | - | - |
| قائمة | GET | `/scim/v2/Groups` | قائمة المجموعات |
| إنشاء | POST | `/scim/v2/Groups` | إنشاء تعيين مجموعة |
| الحصول | GET | `/scim/v2/Groups/{id}` | استرداد مجموعة بواسطة معرف SCIM |
| استبدال | PUT | `/scim/v2/Groups/{id}` | استبدال المجموعة (يعيد تعيين ربط الأدوار) |
| تصحيح | PATCH | `/scim/v2/Groups/{id}` | إضافة أو إزالة أعضاء |
| حذف | DELETE | `/scim/v2/Groups/{id}` | حذف تعيين المجموعة |

### الاكتشاف

| الطريقة | المسار | الوصف |
| - | - | - |
| GET | `/scim/v2/ServiceProviderConfig` | القدرات المدعومة |
| GET | `/scim/v2/Schemas` | مخططات الموارد |
| GET | `/scim/v2/ResourceTypes` | أنواع الموارد المتاحة |

## إنشاء مستخدم

```bash theme={null}
curl -X POST https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "userName": "jane@example.com",
    "name": { "givenName": "Jane", "familyName": "Smith" },
    "emails": [{ "value": "jane@example.com", "primary": true }],
    "active": true
  }'
```

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

ترسل موفرو الهوية مثل Okta و Azure AD طلب PATCH لإلغاء تنشيط المستخدمين:

```bash theme={null}
curl -X PATCH https://api.truthlocks.com/scim/v2/Users/{id} \
  -H "Authorization: Bearer scim_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [{ "op": "replace", "path": "active", "value": false }]
  }'
```

يفقد المستخدمون المعطلون الوصول فورًا ولكن يتم الاحتفاظ ببياناتهم.

## إدارة رموز SCIM

إنشاء الرموز المميزة وإدارتها من خلال واجهة برمجة تطبيقات الإدارة:

```bash theme={null}
# Generate a new token
curl -X POST https://api.truthlocks.com/v1/scim/tokens \
  -H "Authorization: Bearer <admin_token>" \
  -H "Content-Type: application/json" \
  -d '{ "label": "Okta SCIM" }'

# List tokens
curl -X GET https://api.truthlocks.com/v1/scim/tokens \
  -H "Authorization: Bearer <admin_token>"

# Revoke a token
curl -X DELETE https://api.truthlocks.com/v1/scim/tokens/<token_id> \
  -H "Authorization: Bearer <admin_token>"
```

## سجل النشاط

يتم تسجيل جميع عمليات SCIM في سجل النشاط. عرض أحداث التزويد الأخيرة:

```bash theme={null}
curl -X GET https://api.truthlocks.com/v1/scim/activity \
  -H "Authorization: Bearer <admin_token>"
```

تشمل أنواع الأنشطة `USER_CREATED`، `USER_DEACTIVATED`، `USER_PATCHED`، `GROUP_CREATED`، `GROUP_UPDATED`، و `GROUP_DELETED`.

## تطبيق المقاعد

يحترم إنشاء المستخدمين حد المقاعد في خطتك. إذا تم تجاوز الحد، تُرجع نقطة نهاية SCIM HTTP `402` ولا يتم إنشاء المستخدم. قم بترقية خطتك أو إزالة المستخدمين غير النشطين لتحرير المقاعد.

## التصفية

تتيح معلمة استعلام SCIM `filter` لموفر الهوية الخاص بك تضييق نطاق استجابات القائمة لمستخدمين أو مجموعات محددة. يدعم Truthlocks التصفية على سمات SCIM محددة باستخدام العوامل أدناه.

### سمات التصفية المدعومة

| السمة | المورد | الوصف |
| - | - | - |
| `userName` | المستخدمون | معرف تسجيل دخول المستخدم (عادةً عنوان بريد إلكتروني) |
| `displayName` | المستخدمون، المجموعات | اسم عرض المستخدم أو المجموعة |
| `externalId` | المستخدمون، المجموعات | المعرف الفريد المعين من قبل موفر الهوية الخاص بك |
| `active` | المستخدمون | ما إذا كان حساب المستخدم نشطًا (`true` / `false`) |

### العوامل المدعومة

| عامل التشغيل | المعنى | مثال |
| - | - | - |
| `eq` | يساوي | `userName eq "jane@example.com"` |
| `ne` | لا يساوي | `active ne false` |
| `co` | يحتوي على | `userName co "example.com"` |
| `sw` | يبدأ بـ | `userName sw "jane"` |
| `ew` | ينتهي بـ | `userName ew "@example.com"` |

اجمع العوامل باستخدام `and` / `or` للاستعلامات المعقدة:

```bash theme={null}
# Find active users whose username contains "example.com"
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=active eq true and userName co "example.com"'

# Find users starting with "jane" or "john"
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=userName sw "jane" or userName sw "john"'

# Look up a user by their IdP-assigned external ID
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=externalId eq "00u1a2b3c4d5e6f7g8h9"'

# Find a user by display name
curl -G https://api.truthlocks.com/scim/v2/Users \
  -H "Authorization: Bearer scim_your_token_here" \
  --data-urlencode 'filter=displayName eq "Jane Smith"'
```

> [!NOTE]
>
> النتائج المفلترة محددة بـ 200 عنصر لكل استجابة. إذا قام موفر الهوية الخاص بك بمزامنة أكثر من 200 مستخدم أو مجموعة، فيجب عليه تقسيم الصفحات باستخدام المعلمات `startIndex` و`count` جنبًا إلى جنب مع الفلتر.

### أنماط تصفية IdP الشائعة

ترسل معظم موفري الهوية المرشحات تلقائيًا أثناء المزامنة. فيما يلي الأنماط التي يتعامل معها Truthlocks:

| IdP | عامل التصفية النموذجي المرسل |
| - | - |
| Okta | `userName eq "user@example.com"` |
| Azure AD | `userName eq "user@example.com"`، `displayName co "Smith"`، أو `externalId eq "id"` |
| OneLogin | `userName sw "user"` أو `externalId eq "id"` |

إذا أرسل موفر الهوية الخاص بك مرشحًا باستخدام أي من السمات والعمليات المدعومة المذكورة أعلاه، فإن Truthlocks يعالجها بشكل صحيح. لا تحتاج إلى تكوين أي شيء من جانب Truthlocks.

## القدرات المدعومة

| القدرة | مدعومة |
| - | - |
| تصحيح | نعم |
| بالجملة | لا |
| التصفية | نعم — `eq`، `ne`، `co`، `sw`، `ew` على `userName`، `displayName`، `externalId`، `active` مع `and` / `or` (بحد أقصى 200 نتيجة) |
| الفرز | لا |
| تغيير كلمة المرور | لا |
| ETag | لا |

## ذات صلة

* [SAML SSO](https://docs.truthlocks.com/ar/security/saml-sso.md) — مصادقة المستخدمين من خلال IdP الخاص بك.
* [RBAC والأذونات](https://docs.truthlocks.com/ar/security/rbac.md) — الأدوار المخصصة للمستخدمين الموفرين.
* [سجلات التدقيق](https://docs.truthlocks.com/ar/security/audit.md) — تتبع جميع أحداث الوصول والتزويد.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.