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,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  },
  "suspensionTime": string,
  "archivalTime": 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 crypt. ويتوافق مع خوارزميات التجزئة DES وMD5 (بادئة التجزئة $1$) وSHA-256 (بادئة التجزئة $5$) وSHA-512 (بادئة التجزئة $6$).

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

إذا كانت القيمة true، يخضع عنوان IP الخاص بالمستخدم لإعدادات allowlist لعنوان IP المتوقّف نهائيًا.
name

object (UserName)

تحتوي على الاسم الأول واسم العائلة للمستخدم، والقيمة fullName للقراءة فقط. الحدّ الأقصى لعدد الأحرف في givenName وفي قيم familyName هو 60 حرفًا. بالإضافة إلى ذلك، تتوافق قيم الأسماء مع أحرف unicode/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)

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

الحقول

ims[].customProtocol

string

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

ims[].customType

string

إذا كانت السمة 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.
isGuestUser

boolean

غير قابل للتغيير تشير إلى ما إذا كان المستخدم المُدرَج ضيفًا.
guestAccountInfo

object (GuestAccountInfo)

غير قابل للتغيير حقول البيانات الوصفية الإضافية المتعلّقة بالضيوف
suspensionTime

string

النتائج فقط. وقت تعليق حساب المستخدم (للقراءة فقط)
archivalTime

string

النتائج فقط. وقت أرشفة حساب المستخدم (للقراءة فقط)

UserName

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

string

الاسم الكامل للمستخدم الذي يتم تكوينه من خلال ربط قيم الاسم الأول واسم العائلة.
familyName

string

اسم عائلة المستخدم، وهو حقل مطلوب عند إنشاء حساب مستخدم.
givenName

string

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

string

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

GuestAccountInfo

معلومات الحساب الخاصة بمستخدمي وضع الضيف

تمثيل JSON 
{
  "primaryGuestEmail": string
}
الحقول
primaryGuestEmail

string

هذا الحقل غير قابل للتغيير. يمثّل البريد الإلكتروني الخارجي للضيف.

الطُرق

createGuest

 إنشاء حساب مستخدم ضيف يمكنه الوصول إلى مجموعة فرعية من إمكانات Workspace

delete

 يحذف هذا الإجراء مستخدمًا.

get

 تعرض هذه الطريقة معلومات عن مستخدم.

insert

 تنشئ هذه الطريقة مستخدمًا.

list

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

makeAdmin

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

patch

 تعدِّل هذه الطريقة بيانات مستخدم باستخدام دلالات التصحيح.

signOut

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

undelete

 لإلغاء حذف مستخدم محذوف

update

 تعديل مستخدم

watch

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