REST Resource: users

منبع: کاربر

API دایرکتوری به شما امکان می‌دهد کاربران حساب کاربری، نام‌های مستعار کاربر و عکس‌های پروفایل گوگل کاربر را ایجاد و مدیریت کنید. برای اطلاعات بیشتر در مورد وظایف رایج، به راهنمای توسعه‌دهندگان حساب‌های کاربری و راهنمای توسعه‌دهندگان نام‌های مستعار کاربر مراجعه کنید.

نمایش 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)
  }
}
فیلدها
id

string

شناسه منحصر به فرد برای کاربر. id کاربر می‌تواند به عنوان userKey مربوط به URI درخواست کاربر استفاده شود.

primaryEmail

string

آدرس ایمیل اصلی کاربر. این ویژگی در درخواست ایجاد حساب کاربری الزامی است. ایمیل primaryEmail باید منحصر به فرد باشد و نمی‌تواند نام مستعار کاربر دیگری باشد.

password

value ( Value format)

رمز عبور حساب کاربری را ذخیره می‌کند. مقدار رمز عبور کاربر هنگام ایجاد حساب کاربری الزامی است. هنگام به‌روزرسانی کاربر اختیاری است و فقط در صورتی که کاربر رمز عبور حساب خود را به‌روزرسانی کند، باید ارائه شود. مقدار رمز عبور هرگز در بدنه پاسخ API بازگردانده نمی‌شود.

یک رمز عبور می‌تواند شامل هر ترکیبی از کاراکترهای ASCII باشد و باید بین ۸ تا ۱۰۰ کاراکتر باشد.

توصیه می‌کنیم پارامتر password را به صورت یک مقدار هش کدگذاری شده در مبنای شانزده ارسال کنید و hashFunction بر اساس آن تنظیم کنید. اگر hashFunction مشخص شده باشد، رمز عبور باید یک کلید هش معتبر باشد.

hashFunction

string

قالب هش ویژگی password را ذخیره می‌کند. مقادیر hashFunction زیر مجاز هستند:

  • MD5 - مقادیر ساده کدگذاری شده با هگز را می‌پذیرد.
  • SHA-1 - مقادیر ساده کدگذاری شده با هگز را می‌پذیرد.
  • crypt - مطابق با کتابخانه crypt زبان C. از الگوریتم‌های هش DES، MD5 (پیشوند هش $1$ )، SHA-256 (پیشوند هش $5$ ) و SHA-512 (پیشوند هش $6$ ) پشتیبانی می‌کند.

اگر تعداد دورها به عنوان بخشی از پیشوند مشخص شده باشد، باید 10،000 یا کمتر باشد.

isAdmin

boolean

فقط خروجی. نشان دهنده کاربری با امتیازات فوق مدیر است. ویژگی isAdmin فقط در عملیات Make a user as administrator (متد makeAdmin ) قابل ویرایش است. اگر در متدهای درج یا به‌روزرسانی کاربر ویرایش شود، ویرایش توسط سرویس API نادیده گرفته می‌شود.

isDelegatedAdmin

boolean

فقط خروجی. نشان می‌دهد که آیا کاربر یک مدیر با اختیارات تفویض شده است یا خیر.
مدیران تفویض‌شده توسط API پشتیبانی می‌شوند، اما نمی‌توانند کاربران را ایجاد یا بازیابی کنند یا کاربران را به عنوان مدیر تعیین کنند. این درخواست‌ها توسط سرویس API نادیده گرفته می‌شوند.
نقش‌ها و امتیازات مدیران با استفاده از کنسول مدیریت تعیین می‌شوند.

agreedToTerms

boolean

فقط خروجی. این ویژگی در صورتی true است که کاربر ورود اولیه را انجام داده و توافقنامه شرایط خدمات را پذیرفته باشد.

suspended

boolean

نشان می‌دهد که آیا کاربر به حالت تعلیق درآمده است یا خیر.

changePasswordAtNextLogin

boolean

نشان می‌دهد که آیا کاربر مجبور است در ورود بعدی رمز عبور خود را تغییر دهد یا خیر. این تنظیم زمانی که کاربر از طریق ارائه‌دهنده هویت شخص ثالث وارد سیستم می‌شود، اعمال نمی‌شود.

ipWhitelisted

boolean

اگر true ، آدرس IP کاربر تابع پیکربندی منسوخ‌شده‌ی allowlist آدرس IP است.

name

object ( UserName )

نام‌های داده شده و خانوادگی کاربر و مقدار fullName فقط خواندنی را در خود نگه می‌دارد. حداکثر تعداد کاراکتر در مقادیر givenName و familyName ، 60 است. علاوه بر این، مقادیر نام از کاراکترهای unicode/UTF-8 پشتیبانی می‌کنند و می‌توانند شامل فاصله، حروف (az)، اعداد (0-9)، خط تیره (-)، اسلش (/) و نقطه (.) باشند. برای اطلاعات بیشتر در مورد قوانین استفاده از کاراکتر، به مرکز راهنمای مدیریت مراجعه کنید. حداکثر اندازه داده مجاز برای این فیلد 1 کیلوبایت است.

kind

string

فقط خروجی. نوع منبع API. برای منابع کاربران، مقدار 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)

فهرست شناسه‌های خارجی برای کاربر، مانند شناسه کارمند یا شناسه شبکه. حداکثر اندازه داده مجاز ۲ کیلوبایت است.

فیلدها

externalIds[].customType

string

 اگر type شناسه خارجی custom باشد، این ویژگی حاوی مقدار سفارشی است و باید تنظیم شود.

externalIds[].type

string

 نوع شناسه خارجی. اگر روی custom تنظیم شده باشد، customType نیز باید تنظیم شود.

مقادیر قابل قبول: account ، custom ، customer ، login_id ، network ، organization .

externalIds[].value

string

 مقدار شناسه خارجی.

relations

value ( Value format)

فهرست روابط کاربر با سایر کاربران. حداکثر اندازه داده مجاز برای این فیلد ۲ کیلوبایت است. برای اطلاعات بیشتر، به مدیریت حساب‌های کاربری مراجعه کنید.

فیلدها

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

فقط خروجی. نشان می‌دهد که آیا صندوق پستی گوگل کاربر ایجاد شده است یا خیر. این ویژگی فقط در صورتی قابل اجرا است که به کاربر مجوز Gmail اختصاص داده شده باشد.

customerId

string

فقط خروجی. شناسه مشتری برای بازیابی همه کاربران حساب .
شما می‌توانید از نام مستعار my_customer برای نمایش customerId حساب کاربری خود استفاده کنید.
به عنوان مدیر نمایندگی فروش، می‌توانید از customerId حساب مشتریِ دوباره فروخته شده استفاده کنید. برای دریافت customerId ، از دامنه اصلی حساب در پارامتر domain درخواست users.list استفاده کنید.

addresses

value ( Value format)

فهرست آدرس‌های کاربر. حداکثر اندازه داده مجاز ۱۰ کیلوبایت است.

فیلدها

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

 اگر مقدار type برابر با custom باشد، این ویژگی شامل نوع custom می‌شود.

organizations[].department

string

 دپارتمان درون سازمان، مانند sales یا engineering را مشخص می‌کند.

organizations[].description

string

 شرح سازمان.

organizations[].domain

string

 دامنه‌ای که سازمان به آن تعلق دارد.

organizations[].fullTimeEquivalent

integer

 معادل هزارم درصد تمام وقت در سازمان (۱۰۰۰۰۰ = ۱۰۰%).

organizations[].location

string

 مکان فیزیکی سازمان. نیازی نیست که این آدرس کاملاً مشخص باشد.

organizations[].name

string

 نام سازمان.

organizations[].primary

boolean

 نشان می‌دهد که آیا این سازمان اصلی کاربر است یا خیر. هر کاربر فقط می‌تواند یک سازمان اصلی داشته باشد.

organizations[].symbol

string

 نماد متنی سازمان. برای مثال، نماد متنی گوگل 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)

فهرستی از شماره تلفن‌های کاربر. حداکثر حجم مجاز داده ۱ کیلوبایت است.

فیلدها

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

فقط خروجی. دلیل تعلیق حساب کاربری توسط مدیر یا توسط گوگل در زمان تعلیق را نشان می‌دهد. این ویژگی فقط در صورتی برگردانده می‌شود که ویژگی suspended true باشد.

thumbnailPhotoUrl

string

فقط خروجی. آدرس اینترنتی (URL) عکس پروفایل کاربر. این آدرس اینترنتی می‌تواند موقت یا خصوصی باشد.

languages

value ( Value format)

فهرست زبان‌های کاربر. حداکثر اندازه داده مجاز ۱ کیلوبایت است.

فیلدها

languages[].customLanguage

string

 زبان دیگر. کاربر می‌تواند نام زبان خود را در صورت عدم وجود کد زبان ISO 639 مربوطه ارائه دهد. اگر این تنظیم شود، languageCode قابل تنظیم نیست.

languages[].languageCode

string

 نمایش رشته‌ای یک زبان بر اساس استاندارد ISO 639. برای مشاهده لیست کدهای پشتیبانی شده به بخش کدهای زبان مراجعه کنید. کدهای زبان معتبر خارج از مجموعه پشتیبانی شده توسط API پذیرفته می‌شوند، اما ممکن است منجر به رفتار غیرمنتظره‌ای شوند. مقادیر غیرمجاز باعث بروز 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

 شناسه سیستمی که نام کاربری یا شناسه کاربری (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)

فهرست مکان‌های کاربر. حداکثر اندازه داده مجاز ۱۰ کیلوبایت است.

فیلدها

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)

فهرست کلمات کلیدی کاربر. حداکثر حجم مجاز ۱ کیلوبایت است.

فیلدها

keywords[].customType

string

 اگر type کلمه کلیدی custom باشد، این ویژگی حاوی مقدار 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)

یک شیء تو در تو که حاوی جنسیت کاربر است. حداکثر اندازه داده مجاز برای این فیلد ۱ کیلوبایت است.

فیلدها

gender.addressMeAs

string

 یک رشته قابل خواندن توسط انسان که شامل روش صحیح اشاره به صاحب پروفایل توسط انسان است، برای مثال "او/او" یا "آنها/آنها/آنها".

gender.customGender

string

 نام جنسیت سفارشی.

gender.type

string

 نوع جنسیت.

مقادیر قابل قبول:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

فقط خروجی. برچسب الکترونیکی عکس کاربر (فقط خواندنی)

ims

value ( Value format)

حساب‌های کاربری پیام‌رسان فوری (IM). یک حساب کاربری می‌تواند چندین ویژگی ims داشته باشد، اما فقط یکی از این ویژگی‌های ims می‌تواند مخاطب اصلی پیام‌رسان فوری باشد.

فیلدها

ims[].customProtocol

string

 اگر مقدار پروتکل custom_protocol باشد، این ویژگی رشته پروتکل سفارشی را در خود نگه می‌دارد.

ims[].customType

string

 اگر type IM custom باشد، این ویژگی حاوی مقدار سفارشی است و باید تنظیم شود.

ims[].im

string

 شناسه شبکه پیام‌رسان فوری کاربر.

ims[].primary

boolean

 اگر این پیام‌رسان اصلی کاربر باشد، فقط یک ورودی در لیست پیام‌رسان می‌تواند مقدار true داشته باشد.

ims[].protocol

string

 یک پروتکل IM، شبکه IM را شناسایی می‌کند. مقدار می‌تواند یک شبکه سفارشی یا شبکه استاندارد باشد.

مقادیر قابل قبول:
  • aim : پروتکل پیام‌رسان فوری AOL
  • custom_protocol : یک پروتکل شبکه پیام‌رسان سفارشی
  • gtalk : پروتکل گوگل تاک
  • icq : پروتکل ICQ
  • jabber : پروتکل جابر
  • msn : پروتکل پیام‌رسان MSN
  • net_meeting : پروتکل جلسه اینترنتی
  • qq : پروتکل QQ
  • skype : پروتکل اسکایپ
  • yahoo : پروتکل یاهو مسنجر

ims[].type

string

 نوع حساب IM. اگر روی 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 )

تغییرناپذیر. فیلدهای فراداده اضافی مربوط به مهمان

نام کاربری

نمایش JSON 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
فیلدها
fullName

string

نام کامل کاربر که با ترکیب مقادیر نام و نام خانوادگی تشکیل شده است.

familyName

string

نام خانوادگی کاربر. هنگام ایجاد حساب کاربری الزامی است.

givenName

string

نام کوچک کاربر. هنگام ایجاد حساب کاربری الزامی است.

displayName

string

نام نمایشی کاربر. محدودیت: ۲۵۶ کاراکتر.

اطلاعات حساب مهمان

اطلاعات حساب کاربری مخصوص کاربران مهمان.

نمایش JSON 
{
  "primaryGuestEmail": string
}
فیلدها
primaryGuestEmail

string

تغییرناپذیر. ایمیل خارجی مهمان.

روش‌ها

createGuest

 یک کاربر مهمان با دسترسی به زیرمجموعه‌ای از قابلیت‌های Workspace ایجاد کنید.

delete

 یک کاربر را حذف می‌کند.

get

 یک کاربر را بازیابی می‌کند.

insert

 یک کاربر ایجاد می‌کند.

list

 لیست صفحه‌بندی‌شده‌ای از کاربران حذف‌شده یا تمام کاربران یک دامنه را بازیابی می‌کند.

makeAdmin

 یک کاربر را به یک مدیر ارشد تبدیل می‌کند.

patch

 با استفاده از معانی وصله، یک کاربر را به‌روزرسانی می‌کند.

signOut

 کاربر را از تمام جلسات وب و دستگاه خارج می‌کند و کوکی‌های ورود به سیستم او را بازنشانی می‌کند.

undelete

 کاربر حذف شده را بازیابی می‌کند.

update

 یک کاربر را به‌روزرسانی می‌کند.

watch

 تغییرات در لیست کاربران را زیر نظر دارد.