REST Resource: users

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

تسمح لك "واجهة برمجة تطبيقات الدليل" بإنشاء وإدارة مستخدمي حسابك، والأسماء المستعارة للمستخدمين، وصور الملفات الشخصية للمستخدمين على 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_mobilework_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

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

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

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

ims[].im

string

معرّف شبكة IM للمستخدم.

ims[].primary

boolean

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

ims[].protocol

string

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

القيم المقبولة:
  • aim: بروتوكول المراسلة الفورية من AOL
  • 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

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