REST Resource: users

المورد: المستخدِم

تتيح لك Directory API إنشاء مستخدمي حسابك وأسماء المستخدمين البديلة وصور الملفات الشخصية للمستخدمين على Google وإدارتها. لمزيد من المعلومات عن المهام الشائعة، يُرجى الاطّلاع على دليل المطوّر الخاص بحسابات المستخدمين ودليل المطوّر الخاص بأسماء المستخدمين البديلة.

تمثيل JSON 
{
  "id": string,
  "primaryEmail": string,
  "password": value,
  "hashFunction": string,
  "isAdmin": boolean,
  "isDelegatedAdmin": boolean,
  "agreedToTerms": boolean,
  "suspended": boolean,
  "changePasswordAtNextLogin": boolean,
  "ipWhitelisted": boolean,
  "name": {
    object (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string
}
الحقول
id

string

المعرّف الفريد للمستخدِم. يمكن استخدام id مستخدمًا كuserKey لعنوان URI لطلب المستخدم.
primaryEmail

string

عنوان البريد الإلكتروني الرئيسي للمستخدم هذا الموقع مطلوب في طلب إنشاء حساب مستخدم. ويجب أن يكون primaryEmail فريدًا ولا يمكن أن يكون اسمًا مستعارًا لمستخدم آخر.
password

value (Value format)

تخزِّن كلمة المرور لحساب المستخدم. تكون قيمة كلمة مرور المستخدم مطلوبة عند إنشاء حساب مستخدم. هذا الحقل اختياري عند تعديل حساب مستخدم، ويجب عدم تقديمه إلا إذا كان المستخدم يعدّل كلمة مرور حسابه. ولا يتم مطلقًا عرض قيمة كلمة المرور في نص استجابة واجهة برمجة التطبيقات.

يمكن أن تحتوي كلمة المرور على أي مجموعة من أحرف ASCII، ويجب أن تتراوح بين 8 و100 حرف.

ننصحك بإرسال المَعلمة password كقيمة تجزئة بترميز سداسي عشري وضبط hashFunction وفقًا لذلك. في حال تحديد hashFunction، يجب أن تكون كلمة المرور مفتاح تجزئة صالحًا.
hashFunction

string

تخزِّن تنسيق التجزئة للسمة password. قيم hashFunction التالية مسموح بها:

  • MD5 - تقبل القيم البسيطة ذات الترميز السداسي.
  • ‫SHA-1 - يقبل القيم البسيطة المُشفَّرة باستخدام الأرقام الستة عشرية.
  • crypt - التوافق مع مكتبة التشفير C يتوافق مع خوارزميات التجزئة DES وMD5 (بادئة التجزئة $1$) وSHA-256 (بادئة التجزئة $5$) وSHA-512 (بادئة التجزئة $6$).

إذا تم تحديد الجولات كجزء من البادئة، يجب أن تكون 10,000 أو أقل.
isAdmin

boolean

النتائج فقط. تشير إلى مستخدم لديه امتيازات المشرف المتميّز. لا يمكن تعديل السمة isAdmin إلا في عملية تعيين مستخدم مشرفًا ( طريقة makeAdmin). إذا تم إجراء التعديل في طريقتَي الإدراج أو التحديث الخاصة بالمستخدم، تتجاهل خدمة واجهة برمجة التطبيقات التعديل.
isDelegatedAdmin

boolean

النتائج فقط. يشير إلى ما إذا كان المستخدم مشرفًا مفوَّضًا.
تتيح واجهة برمجة التطبيقات للمشرفين المفوَّضين إنشاء مستخدمين أو إلغاء حذفهم أو منحهم دور المشرف. وتتجاهل خدمة واجهة برمجة التطبيقات هذه الطلبات.
يتم منح الأدوار والامتيازات للمشرفين باستخدام وحدة تحكّم المشرف.
agreedToTerms

boolean

النتائج فقط. يكون هذا الحقل true إذا أكمل المستخدم عملية تسجيل دخول أولية وقبل اتفاقية بنود الخدمة.
suspended

boolean

تشير إلى ما إذا كان المستخدم معلّقًا.
changePasswordAtNextLogin

boolean

يشير إلى ما إذا كان المستخدم مضطرًا لتغيير كلمة المرور عند تسجيل الدخول التالي. لا ينطبق هذا الإعداد عند تسجيل المستخدم الدخول من خلال موفِّر هوية تابع لجهة خارجية.
ipWhitelisted

boolean

إذا كانت true، يخضع عنوان IP للمستخدم لإعداد عنوان IP متوقف allowlist.
name

object (UserName)

يحتوي على الاسم الأول واسم العائلة للمستخدم، وقيمة fullName للقراءة فقط. الحد الأقصى لعدد الأحرف في قيم givenName وfamilyName هو 60 حرفًا. بالإضافة إلى ذلك، تتوافق قيم الأسماء مع أحرف يونيكود/UTF-8، ويمكن أن تحتوي على مسافات وحروف (a-z) وأرقام (0-9) وشرطات (-) وشُرط مائلة للأمام (/) ونقاط (.). لمزيد من المعلومات حول قواعد استخدام الأحرف، يُرجى الاطّلاع على مركز مساعدة الإدارة. يبلغ الحد الأقصى المسموح به لحجم البيانات في هذا الحقل 1 كيلوبايت.
kind

string

النتائج فقط. نوع مورد واجهة برمجة التطبيقات بالنسبة إلى موارد "المستخدِمون"، تكون القيمة admin#directory#user.
etag

string

النتائج فقط. علامة ETag للمورد
emails

value (Value format)

قائمة عناوين البريد الإلكتروني للمستخدم يبلغ الحد الأقصى المسموح به لحجم البيانات 10 كيلوبايت.

الحقول

emails[].address

string

عنوان البريد الإلكتروني للمستخدِم ويعمل أيضًا كمعرّف البريد الإلكتروني. يمكن أن تكون هذه القيمة عنوان البريد الإلكتروني الأساسي للمستخدم أو عنوان بديل.

emails[].customType

string

إذا كان عنوان البريد الإلكتروني type هو custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

emails[].primary

boolean

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

emails[].type

string

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

القيم المقبولة: custom وhome وother وwork.
externalIds

value (Value format)

قائمة المعرّفات الخارجية للمستخدم، مثل معرّف الموظف أو معرّف الشبكة الحد الأقصى المسموح به لحجم البيانات هو 2 كيلوبايت.

الحقول

externalIds[].customType

string

إذا كان رقم التعريف الخارجي type هو custom، يجب ضبط هذه السمة على القيمة المخصّصة.

externalIds[].type

string

نوع المعرّف الخارجي في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: account وcustom وcustomer وlogin_id وnetwork وorganization.

externalIds[].value

string

قيمة المعرّف الخارجي.
relations

value (Value format)

قائمة بعلاقات المستخدم مع المستخدمين الآخرين إنّ الحدّ الأقصى المسموح به لحجم البيانات في هذا الحقل هو 2 كيلوبايت. لمزيد من المعلومات، يُرجى الاطّلاع على إدارة حسابات المستخدمين.

الحقول

relations[].customType

string

إذا كانت العلاقة type هي custom، يجب ضبط هذه السمة على القيمة المخصّصة.

relations[].type

string

نوع العلاقة في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

عنوان البريد الإلكتروني للشخص المرتبط به المستخدم.
aliases[]

string

النتائج فقط. قائمة عناوين البريد الإلكتروني البديلة للمستخدم
isMailboxSetup

boolean

النتائج فقط. يشير إلى ما إذا تم إنشاء صندوق بريد Google للمستخدم. لا ينطبق هذا السمة إلا إذا تم منح المستخدم ترخيص Gmail.
customerId

string

النتائج فقط. هو الرقم التعريفي للعميل لاسترداد جميع مستخدمي الحساب.
يمكنك استخدام الاسم المستعار my_customer لتمثيل customerId الخاصة بحسابك.
بصفتك مشرف مورِّد، يمكنك استخدام customerId لحساب العميل الذي تمت إعادة بيعه. للحصول على customerId، استخدِم النطاق الأساسي للحساب في المَعلمة domain لطلب users.list.
addresses

value (Value format)

قائمة عناوين المستخدم الحد الأقصى المسموح به لحجم البيانات هو 10 كيلوبايت.

الحقول

addresses[].country

string

البلد.

addresses[].countryCode

string

رمز البلد. يستخدم معيار ISO 3166-1.

addresses[].customType

string

إذا كان العنوان type هو custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

addresses[].extendedAddress

string

للعناوين المُلحقة، مثل العنوان الذي يتضمّن منطقة فرعية

addresses[].formatted

string

عنوان بريدي كامل وغير منظم. لا تتم مزامنة هذه البيانات مع حقول العناوين المنظَّمة. تتضمّن السمات التالية: عنوان الشارع، صندوق البريد، المدينة، الولاية/المقاطعة، الرمز البريدي/رمز المنطقة، البلد/المنطقة.

addresses[].locality

string

البلدة أو المدينة التي يقع فيها العنوان

addresses[].poBox

string

صندوق البريد، إن توفّر

addresses[].postalCode

string

تمثّل هذه السمة الرمز البريدي، إذا كان ذلك منطبقًا.

addresses[].primary

boolean

إذا كان هذا هو العنوان الأساسي للمستخدم. لا يمكن أن تحتوي قائمة العناوين إلا على عنوان أساسي واحد.

addresses[].region

string

اختصار المقاطعة أو الولاية

addresses[].sourceIsStructured

boolean

تشير إلى ما إذا تم تنسيق العنوان الذي قدّمه المستخدم. لا تتوفّر حاليًا عناوين منسَّقة.

addresses[].streetAddress

string

تمثّل هذه السمة عنوان الشارع، مثل 1600 Amphitheatre Parkway. يتم تجاهل المسافة البيضاء داخل السلسلة، ولكن تكون سطور الالتفاف مهمة.

addresses[].type

string

نوع العنوان في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: custom وhome وother وwork.
organizations

value (Value format)

قائمة المؤسسات التي ينتمي إليها المستخدم الحد الأقصى المسموح به لحجم البيانات هو 10 كيلوبايت.

الحقول

organizations[].costCenter

string

مركز تكلفة مؤسسة المستخدم.

organizations[].customType

string

إذا كانت قيمة النوع مخصّصة، ستحتوي هذه السمة على النوع المخصّص.

organizations[].department

string

تُستخدَم لتحديد القسم داخل المؤسسة، مثل sales أو engineering.

organizations[].description

string

تمثل هذه السمة وصف المؤسسة.

organizations[].domain

string

تمثّل هذه السمة النطاق الذي تنتمي إليه المؤسسة.

organizations[].fullTimeEquivalent

integer

النسبة المئوية بالميلّي ضمن المؤسسة بما يعادل العمل بدوام كامل (100000 = %100).

organizations[].location

string

الموقع الجغرافي للمؤسسة ولا يُشترَط أن يكون هذا العنوان مؤهَّلاً بالكامل.

organizations[].name

string

اسم المؤسسة

organizations[].primary

boolean

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

organizations[].symbol

string

رمز سلسلة النصوص للمؤسسة على سبيل المثال، رمز النص لشركة Google هو GOOG.

organizations[].title

string

مسمّى المستخدم داخل المؤسسة. على سبيل المثال، member أو engineer.

organizations[].type

string

نوع المؤسسة

القيم المقبولة: domain_only وschool وunknown وwork.
lastLoginTime

string

النتائج فقط. آخر مرة سجّل فيها المستخدم الدخول إلى حسابه. تكون القيمة بتنسيق التاريخ والوقت ISO 8601. الوقت هو التاريخ الكامل مع الساعات والدقائق والثواني بالتنسيق YYYY-MM-DDThh:mm:ssTZD. على سبيل المثال، 2010-04-05T17:30:04+01:00.
phones

value (Value format)

قائمة بأرقام هواتف المستخدم الحد الأقصى المسموح به لحجم البيانات هو 1 كيلوبايت.

الحقول

phones[].customType

string

إذا كان رقم الهاتف type هو custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

phones[].primary

boolean

إذا كان true، هذا هو رقم هاتف المستخدم الأساسي. يمكن للمستخدم أن يكون لديه رقم هاتف أساسي واحد فقط.

phones[].type

string

نوع رقم الهاتف في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: assistant وcallback وcar وcompany_main وcustom وgrand_central وhome وhome_fax وisdn وmain وmobile وother وother_fax وpager وradio وtelex وtty_tdd وwork وwork_fax وwork_mobile وwork_pager.

phones[].value

string

رقم هاتف يمكن لشخص عادي قراءته يمكن أن يكون بأي تنسيق رقم هاتف.
suspensionReason

string

النتائج فقط. يمتلك سببًا لتعليق حساب المستخدم إما من قِبل المشرف أو من قِبل Google وقت التعليق. لا يتم عرض السمة إلا إذا كانت قيمة السمة suspended هي true.
thumbnailPhotoUrl

string

النتائج فقط. عنوان URL لصورة الملف الشخصي للمستخدم قد يكون عنوان URL مؤقتًا أو خاصًا.
languages

value (Value format)

قائمة لغات المستخدم. الحد الأقصى المسموح به لحجم البيانات هو 1 كيلوبايت.

الحقول

languages[].customLanguage

string

لغة أخرى يمكن للمستخدم تقديم اسم اللغة الخاص به في حال عدم توفّر رمز لغة ISO 639 ذي الصلة. في حال ضبط هذا الخيار، لا يمكن ضبط languageCode.

languages[].languageCode

string

تمثيل سلسلة ISO 639 لإحدى اللغات. اطّلِع على رموز اللغات للحصول على قائمة بالرموز المسموح بها. ستقبل واجهة برمجة التطبيقات رموز اللغات الصالحة خارج المجموعة المتوافقة، ولكن قد تؤدي إلى سلوك غير متوقّع. تؤدي القيم غير القانونية إلى حدوث SchemaException. في حال ضبط هذا الخيار، لا يمكن ضبط customLanguage.

languages[].preference

string

اختياريّ. في حال توفّرها، تتحكّم في ما إذا كانت languageCode المحدّدة هي اللغة المفضّلة للمستخدم. إذا تم ضبط السياسة customLanguage، لا يمكن ضبطها. القيمتان المسموح بإدراجهما هما preferred وnot_preferred.
posixAccounts

value (Value format)

قائمة معلومات حساب POSIX للمستخدم

الحقول

posixAccounts[].accountId

string

معرّف حقل حساب POSIX

posixAccounts[].gecos

string

GECOS (معلومات المستخدم) لهذا الحساب

posixAccounts[].gid

unsigned long

رقم تعريف المجموعة التلقائي.

posixAccounts[].homeDirectory

string

المسار إلى الدليل الرئيسي لهذا الحساب.

posixAccounts[].operatingSystemType

string

نوع نظام التشغيل لهذا الحساب.

القيم المقبولة: linux وunspecified وwindows.

posixAccounts[].primary

boolean

إذا كان هذا هو الحساب الأساسي للمستخدم ضمن SystemId.

posixAccounts[].shell

string

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

posixAccounts[].systemId

string

معرّف النظام الذي ينطبق عليه اسم المستخدم أو المعرّف الفريد للمستخدم.

posixAccounts[].uid

unsigned long

رقم تعريف المستخدم المتوافق مع POSIX

posixAccounts[].username

string

اسم مستخدم الحساب.
creationTime

string

النتائج فقط. وقت إنشاء حساب المستخدم. تكون القيمة بتنسيق التاريخ والوقت ISO 8601. الوقت هو التاريخ الكامل مع الساعات والدقائق والثواني بالتنسيق YYYY-MM-DDThh:mm:ssTZD. مثلاً: 2010-04-05T17:30:04+01:00
nonEditableAliases[]

string

النتائج فقط. قائمة بعناوين البريد الإلكتروني للاسم المستعار غير القابلة للتعديل للمستخدم. وعادةً ما تكون خارج النطاق الأساسي أو النطاق الفرعي للحساب.
sshPublicKeys

value (Value format)

قائمة بمفاتيح SSH العامة

الحقول

sshPublicKeys[].expirationTimeUsec

long

وقت انتهاء الصلاحية بالميكرو ثانية منذ تاريخ بدء حساب الفترة

sshPublicKeys[].fingerprint

string

بصمة إصبع SHA-256 لمفتاح SSH العام (للقراءة فقط)

sshPublicKeys[].key

string

مفتاح SSH العام
notes

value (Value format)

ملاحظات المستخدم كعنصر مُدمَج

الحقول

notes.contentType

string

نوع محتوى الملاحظة، إما نص عادي أو HTML الإعداد التلقائي هو نص عادي.

القيم المقبولة: text_plain وtext_html.

notes.value

string

محتوى الملاحظات
websites

value (Value format)

قائمة المواقع الإلكترونية للمستخدم

الحقول

websites[].customType

string

إذا كان الموقع الإلكتروني type هو custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

websites[].primary

boolean

إذا كان true، هذا هو الموقع الإلكتروني الأساسي للمستخدم.

websites[].type

string

نوع الموقع الإلكتروني أو الغرض منه على سبيل المثال، يمكن تصنيف موقع إلكتروني على أنّه home أو blog. بدلاً من ذلك، يمكن أن يكون للعنصر نوع custom. في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: app_install_page وblog وcustom وftp وhome وhome_page وother وprofile وreservations وresume وwork.

websites[].value

string

عنوان URL للموقع الإلكتروني.
locations

value (Value format)

قائمة المواقع الجغرافية للمستخدم الحد الأقصى المسموح به لحجم البيانات هو 10 كيلوبايت.

الحقول

locations[].area

string

الموقع الجغرافي النصي يُعدّ ذلك مفيدًا جدًا لأغراض العرض لوصف الموقع الجغرافي بإيجاز. على سبيل المثال، Mountain View, CA أو Near Seattle.

locations[].buildingId

string

معرّف المبنى

locations[].customType

string

إذا كان الموقع الجغرافي type هو custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

locations[].deskCode

string

الرمز النصي الأكثر تحديدًا لموقع مكتب فردي

locations[].floorName

string

اسم الطابق أو رقمه

locations[].floorSection

string

قسم الطابق موقع أكثر تحديدًا في الطابق. على سبيل المثال، إذا تم تقسيم طابق إلى الأقسام A وB وC، سيحدِّد هذا الحقل إحدى هذه القيم.

locations[].type

string

نوع الموقع الجغرافي في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: custom وdefault وdesk.
includeInGlobalAddressList

boolean

يشير هذا الرمز إلى ما إذا كان الملف الشخصي للمستخدم مرئيًا في قائمة العناوين العامة في Google Workspace عند تفعيل ميزة مشاركة جهات الاتصال للنطاق. لمزيد من المعلومات عن استبعاد الملفات الشخصية للمستخدمين، يُرجى الاطّلاع على مركز مساعدة الإدارة.
keywords

value (Value format)

قائمة الكلمات الرئيسية للمستخدم. الحد الأقصى المسموح به لحجم البيانات هو 1 كيلوبايت.

الحقول

keywords[].customType

string

إذا كانت الكلمة الرئيسية type هي custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

keywords[].type

string

يمكن أن يكون لكل إدخال نوع يشير إلى النوع العادي لذلك الإدخال.

على سبيل المثال، يمكن أن تكون الكلمة الرئيسية من النوع occupation أو outlook. بالإضافة إلى النوع العادي، يمكن أن يكون للعنصر نوع custom ويمكن تسميته بأي اسم. في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: custom وmission وoccupation وoutlook.

keywords[].value

string

الكلمة الرئيسية
deletionTime

string

النتائج فقط. وقت حذف حساب المستخدم تكون القيمة بتنسيق التاريخ والوقت ISO 8601. الوقت هو التاريخ الكامل مع الساعات والدقائق والثواني بالتنسيق YYYY-MM-DDThh:mm:ssTZD. على سبيل المثال: 2010-04-05T17:30:04+01:00.
gender

value (Value format)

تمثّل هذه السمة كائنًا مدمجًا يحتوي على جنس المستخدم. الحد الأقصى المسموح به لحجم البيانات في هذا الحقل هو 1 كيلوبايت.

الحقول

gender.addressMeAs

string

سلسلة يمكن لشخص عادي قراءتها وتتضمن الطريقة الصحيحة للإشارة إلى مالك الملف الشخصي، على سبيل المثال "هو/له" أو "هم/لهم"

gender.customGender

string

اسم جنس مخصّص

gender.type

string

 نوع الجنس

القيم المقبولة:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

النتائج فقط. علامة ETag لصورة المستخدم (للقراءة فقط)
ims

value (Value format)

حسابات المراسلة الفورية (IM) للمستخدم. يمكن أن يتضمّن حساب المستخدم عدة مواقع ims، ولكن يمكن أن يكون موقع واحد فقط من مواقع ims هذه هو جهة الاتصال الأساسية للمحادثة الفورية.

الحقول

ims[].customProtocol

string

إذا كانت قيمة البروتوكول هي custom_protocol، تحتوي هذه السمة على سلسلة البروتوكول المخصّص.

ims[].customType

string

إذا كانت قيمة السمة IM type هي custom، تحتوي هذه السمة على القيمة المخصّصة ويجب ضبطها.

ims[].im

string

معرّف شبكة المراسلة الفورية للمستخدم

ims[].primary

boolean

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

ims[].protocol

string

 يحدِّد بروتوكول المراسلة الفورية شبكة المراسلة الفورية. يمكن أن تكون القيمة شبكة مخصّصة أو الشبكة العادية.

القيم المقبولة:
  • aim: بروتوكول AOL Instant Messenger
  • custom_protocol: بروتوكول شبكة مخصّص لمحادثات الفيديو
  • gtalk: بروتوكول Google Talk
  • icq: بروتوكول ICQ
  • jabber: بروتوكول Jabber
  • ‫msn: بروتوكول MSN Messenger
  • net_meeting: بروتوكول Net Meeting
  • qq: بروتوكول QQ
  • skype: بروتوكول Skype
  • yahoo: بروتوكول Yahoo Messenger

ims[].type

string

نوع حساب المراسلة الفورية في حال ضبط القيمة على custom، يجب أيضًا ضبط القيمة customType.

القيم المقبولة: custom وhome وother وwork.
customSchemas

value (Value format)

الحقول المخصّصة للمستخدم المفتاح هو schemaName والقيم هي 'fieldName': 'field_value'.

  • customSchemas.(key) هو عنصر مُدمَج.
  • يمكن أن تكون customSchemas.(key).(key) أي قيمة.
isEnrolledIn2Sv

boolean

النتائج فقط. تم تسجيله في ميزة "التحقّق بخطوتين" (للقراءة فقط)
isEnforcedIn2Sv

boolean

النتائج فقط. هل يتم فرض التحقق بخطوتين (للقراءة فقط)
archived

boolean

تشير إلى ما إذا كان المستخدم مُدرَجًا في الأرشيف.
orgUnitPath

string

تمثّل هذه السمة المسار الكامل للمؤسسة الرئيسية المرتبطة بالمستخدم. إذا كانت المؤسسة الرئيسية هي المستوى الأعلى، يتم تمثيلها بشرطة مائلة للأمام (/).
recoveryEmail

string

البريد الإلكتروني المخصّص لاسترداد حساب المستخدم.
recoveryPhone

string

رقم الهاتف المخصّص لاسترداد حساب المستخدم يجب أن يكون رقم الهاتف بتنسيق E.164، ويبدأ بعلامة الجمع (+). على سبيل المثال: +16506661212.

UserName

تمثيل JSON 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
الحقول
fullName

string

الاسم الكامل للمستخدم مكون من تسلسل قيمتي الاسم الأول واسم العائلة.
familyName

string

تمثّل هذه السمة اسم العائلة للمستخدِم. مطلوب عند إنشاء حساب مستخدم.
givenName

string

الاسم الأول للمستخدم. مطلوب عند إنشاء حساب مستخدم.
displayName

string

الاسم المعروض للمستخدم. الحد الأقصى المسموح به: 256 حرفًا.

الطُرق

delete

 لحذف مستخدم

get

 استرداد مستخدم

insert

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

list

 يسترجع هذه الوظيفة قائمة مفصّلة بالمستخدمين المحذوفين أو جميع المستخدمين في نطاق.

makeAdmin

 منح مستخدم دور المشرف المتميّز

patch

 تعديل مستخدم باستخدام دلالات تصحيح الأخطاء

signOut

 يتم تسجيل خروج المستخدم من جميع جلسات الويب والأجهزة وإعادة ضبط ملفات تعريف ارتباط تسجيل الدخول.

undelete

 لإعادة عرض مستخدم تم حذفه

update

 تعديل مستخدم

watch

 تتتبّع التغييرات في قائمة المستخدمين.