Method: schemas.get

یک طرحواره را بازیابی می کند.

درخواست HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/schemas/{schemaKey}

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
customerId

string

شناسه منحصر به فرد برای حساب Google Workspace مشتری. در مورد حساب چند دامنه ای، برای واکشی همه گروه ها برای مشتری، به جای domain از این فیلد استفاده کنید. همچنین می توانید از نام مستعار my_customer برای نشان دادن customerId حساب خود استفاده کنید. customerId نیز به عنوان بخشی از منبع کاربران بازگردانده می شود. شما باید یا customer یا پارامتر domain ارائه دهید.

schemaKey

string

نام یا شناسه تغییرناپذیر طرحواره.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Schema است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/admin.directory.userschema
  • https://www.googleapis.com/auth/admin.directory.userschema.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.