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 باعتباره عنوان URI لطلب المستخدم userKey.
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$).

إذا تم تحديد الجولات كجزء من البادئة، يجب أن تكون 10000 أو أقل.
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 حرفًا. بالإضافة إلى ذلك، تتوافق قيم الأسماء مع أحرف 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

النسبة المئوية المئوية المكافئة بدوام كامل داخل المؤسسة (100,000 = 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_mobile وwork_mobilework_faxwork_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

إذا كان هذا هو الحساب الأساسي للمستخدم ضمن رقم تعريف النظام

posixAccounts[].shell

string

المسار إلى هيكل تسجيل الدخول لهذا الحساب.

posixAccounts[].systemId

string

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

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

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

ims[].protocol

string

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

القيم المقبولة:
  • aim: بروتوكول المراسلة الفورية من AdWords
  • custom_protocol: بروتوكول شبكة رسائل فورية مخصص
  • gtalk: بروتوكول Google Talk
  • icq: بروتوكول ICQ
  • jabber: بروتوكول Jabber
  • msn: بروتوكول MSN Messenger
  • net_meeting: بروتوكول Net Meeting
  • qq: بروتوكول QQ
  • skype: بروتوكول سكايب
  • yahoo: بروتوكول Yahoo Messenger

ims[].type

string

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

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

value (Value format)

الحقول المخصّصة للمستخدم. الحد الأقصى المسموح به لحجم البيانات هو 32 كيلوبايت. المفتاح هو 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

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