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 crypt. يتيح استخدام خوارزميات التجزئة 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

القيمة المئوية بالملي ثانية التي تعمل بدوام كامل في المؤسسة (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_fax وwork_fax وwork_mobile وwork_mobile

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

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

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

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

ims[].im

string

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

ims[].primary

boolean

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

ims[].protocol

string

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

القيم المقبولة:
  • aim: بروتوكول المراسلة الفورية في AOL
  • custom_protocol: بروتوكول شبكة IM مخصص
  • gtalk: بروتوكول Google Talk
  • icq: بروتوكول ICQ
  • jabber: بروتوكول Jabber
  • msn: بروتوكول MSN Messenger
  • 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.

اسم المستخدم

تمثيل 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

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