این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

REST Resource: users

منبع: کاربر

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

نمایندگی JSON

نمایندگی 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,
  "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's userKey استفاده شود.

primaryEmail

string

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

password

value ( Value format)

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

رمز عبور می تواند حاوی هر ترکیبی از کاراکترهای 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

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

isDelegatedAdmin

boolean

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

agreedToTerms

boolean

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

suspended

boolean

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

changePasswordAtNextLogin

boolean

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

ipWhitelisted

boolean

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

name

object ( UserName )

نام داده شده و نام خانوادگی کاربر و مقدار fullName فقط خواندنی را در خود دارد. حداکثر تعداد کاراکترها در givenName و در مقادیر familyName 60 است. علاوه بر این، مقادیر نام از نویسه‌های یونیکد/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)

لیست شناسه های خارجی برای کاربر، مانند شناسه کارمند یا شبکه. حداکثر اندازه مجاز داده 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

فقط خروجی نشان می دهد که آیا صندوق پست گوگل کاربر ایجاد شده است یا خیر. این ویژگی فقط در صورتی قابل اعمال است که به کاربر مجوز 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 ممکن است موقت یا خصوصی باشد.

languages

value ( Value format)

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

فیلدها

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

آدرس وب سایت.

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 می‌تواند مخاطب اولیه IM باشد.

فیلدها

ims[].customProtocol

string

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

ims[].customType

string

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

ims[].im

string

شناسه شبکه IM کاربر.

ims[].primary

boolean

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

ims[].protocol

string

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

ارزش های قابل قبول:

aim : پروتکل AOL Instant Messenger
custom_protocol : یک پروتکل شبکه IM سفارشی
gtalk : پروتکل Google Talk
icq : پروتکل ICQ
jabber : پروتکل Jabber
msn : پروتکل MSN Messenger
net_meeting : پروتکل 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 .

نام کاربری

نمایندگی JSON
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

فیلدها
`fullName`	`string` نام کامل کاربر از به هم پیوستن مقادیر نام و نام خانوادگی تشکیل شده است.
`familyName`	`string` نام خانوادگی کاربر. هنگام ایجاد یک حساب کاربری ضروری است.
`givenName`	`string` نام کوچک کاربر هنگام ایجاد یک حساب کاربری ضروری است.
`displayName`	`string` نام نمایشی کاربر محدودیت: 256 کاراکتر.

روش ها
`delete`	یک کاربر را حذف می کند.
`get`	یک کاربر را بازیابی می کند.
`insert`	کاربر ایجاد می کند.
`list`	یک لیست صفحه بندی شده از کاربران حذف شده یا همه کاربران یک دامنه را بازیابی می کند.
`makeAdmin`	کاربر را به یک مدیر فوق العاده تبدیل می کند.
`patch`	کاربر را با استفاده از پچ semantics به روز می کند.
`signOut`	کاربر را از تمام جلسات وب و دستگاه خارج می کند و کوکی های ورود به سیستم او را بازنشانی می کند.
`undelete`	حذف یک کاربر حذف شده را لغو می کند.
`update`	یک کاربر را به روز می کند.
`watch`	ساعت برای تغییرات در لیست کاربران.

REST Resource: users

منبع: کاربر

نام کاربری

روش ها

`delete`

`get`

`insert`

`list`

`makeAdmin`

`patch`

`signOut`

`undelete`

`update`

`watch`