Admin SDK: Directory API

رابط برنامه‌نویسی کاربردی (API) دایرکتوری SDK مدیریت به مدیران دامنه‌های سازمانی اجازه می‌دهد تا کاربران، گروه‌ها، دستگاه‌ها و منابع مرتبط سازمان خود را مشاهده و مدیریت کنند. رابط‌های برنامه‌نویسی کاربردی Cloud Identity روش‌های بیشتری برای مدیریت برخی از همین منابع ارائه می‌دهند.

سرویس: admin.googleapis.com

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

سند کشف

یک سند کشف ، مشخصاتی قابل خواندن توسط ماشین برای توصیف و استفاده از APIهای REST است. از آن برای ساخت کتابخانه‌های کلاینت، افزونه‌های IDE و سایر ابزارهایی که با APIهای گوگل تعامل دارند، استفاده می‌شود. یک سرویس ممکن است چندین سند کشف ارائه دهد. این سرویس سند کشف زیر را ارائه می‌دهد:

نقطه پایانی سرویس

یک نقطه پایانی سرویس ، یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می‌کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و تمام URI های زیر نسبت به این نقطه پایانی سرویس هستند:

  • https://admin.googleapis.com

منبع REST: asps

روش‌ها
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
یک ASP صادر شده توسط یک کاربر را حذف می‌کند.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
اطلاعاتی در مورد ASP صادر شده توسط کاربر دریافت می‌کند.
list GET /admin/directory/v1/users/{userKey}/asps
ASP های صادر شده توسط یک کاربر را لیست می کند.

منبع REST: chromeosdevices

روش‌ها
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
به جای آن از BatchChangeChromeOsDeviceStatus استفاده کنید.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
ویژگی‌های دستگاه دارای سیستم عامل کروم را بازیابی می‌کند.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
فهرست صفحه‌بندی‌شده‌ای از دستگاه‌های سیستم عامل کروم درون یک حساب را بازیابی می‌کند.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
چندین دستگاه سیستم عامل Chrome را به یک واحد سازمانی منتقل یا وارد می‌کند.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
ویژگی‌های قابل به‌روزرسانی یک دستگاه، مانند annotatedUser ، annotatedLocation ، notes ، orgUnitPath یا annotatedAssetId را به‌روزرسانی می‌کند.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
ویژگی‌های قابل به‌روزرسانی یک دستگاه، مانند annotatedUser ، annotatedLocation ، notes ، orgUnitPath یا annotatedAssetId را به‌روزرسانی می‌کند.

منبع REST: customer.devices.chromeos

روش‌ها
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
وضعیت دسته‌ای از دستگاه‌های ChromeOS را تغییر می‌دهد.
countChromeOsDevices GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices
دستگاه‌های ChromeOS منطبق با درخواست را می‌شمارد.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
دستوری را برای اجرا به دستگاه صادر می‌کند.

منبع REST: customer.devices.chromeos.commands

روش‌ها
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
داده‌های فرمان، یک فرمان خاص صادر شده به دستگاه را دریافت می‌کند.

منبع REST: مشتریان

روش‌ها
get GET /admin/directory/v1/customers/{customerKey}
مشتری را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customers/{customerKey}
وصله‌های مشتری را وصله می‌کند.
update PUT /admin/directory/v1/customers/{customerKey}
مشتری را به‌روزرسانی می‌کند.

منبع REST: domainAliases

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
نام مستعار دامنه مشتری را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
نام مستعار دامنه مشتری را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
نام مستعار دامنه مشتری را وارد می‌کند.
list GET /admin/directory/v1/customer/{customer}/domainaliases
نام‌های مستعار دامنه مشتری را فهرست می‌کند.

منبع REST: دامنه‌ها

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
دامنه مشتری را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
دامنه مشتری را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customer}/domains
دامنه مشتری را وارد می‌کند.
list GET /admin/directory/v1/customer/{customer}/domains
دامنه‌های مشتری را فهرست می‌کند.

منبع REST: گروه‌ها

روش‌ها
delete DELETE /admin/directory/v1/groups/{groupKey}
یک گروه را حذف می‌کند.
get GET /admin/directory/v1/groups/{groupKey}
ویژگی‌های یک گروه را بازیابی می‌کند.
insert POST /admin/directory/v1/groups
یک گروه ایجاد می‌کند.
list GET /admin/directory/v1/groups
تمام گروه‌های یک دامنه یا یک کاربر را با توجه به userKey (صفحه‌بندی‌شده) بازیابی می‌کند.
patch PATCH /admin/directory/v1/groups/{groupKey}
ویژگی‌های یک گروه را به‌روزرسانی می‌کند.
update PUT /admin/directory/v1/groups/{groupKey}
ویژگی‌های یک گروه را به‌روزرسانی می‌کند.

منبع REST: groups.aliases

روش‌ها
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
یک نام مستعار را حذف می‌کند.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
یک نام مستعار برای گروه اضافه می‌کند.
list GET /admin/directory/v1/groups/{groupKey}/aliases
تمام نام‌های مستعار یک گروه را فهرست می‌کند.

منبع REST: اعضا

روش‌ها
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
یک عضو را از گروه حذف می‌کند.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
ویژگی‌های یک عضو گروه را بازیابی می‌کند.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
بررسی می‌کند که آیا کاربر داده شده عضو گروه است یا خیر.
insert POST /admin/directory/v1/groups/{groupKey}/members
یک کاربر را به گروه مشخص شده اضافه می‌کند.
list GET /admin/directory/v1/groups/{groupKey}/members
لیست صفحه‌بندی شده‌ای از تمام اعضای یک گروه را بازیابی می‌کند.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
ویژگی‌های عضویت یک کاربر در گروه مشخص شده را به‌روزرسانی می‌کند.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
عضویت یک کاربر در گروه مشخص شده را به‌روزرسانی می‌کند.

منبع REST: دستگاه‌های موبایل

روش‌ها
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
اقدامی انجام می‌دهد که بر دستگاه تلفن همراه تأثیر می‌گذارد.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
یک دستگاه تلفن همراه را حذف می‌کند.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
ویژگی‌های یک دستگاه تلفن همراه را بازیابی می‌کند.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
فهرست صفحه‌بندی‌شده‌ای از تمام دستگاه‌های تلفن همراه متعلق به کاربر را برای یک حساب بازیابی می‌کند.

منبع REST: orgunits

روش‌ها
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
یک واحد سازمانی را حذف می‌کند.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
یک واحد سازمانی را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
یک واحد سازمانی اضافه می‌کند.
list GET /admin/directory/v1/customer/{customerId}/orgunits
فهرستی از تمام واحدهای سازمانی یک حساب کاربری را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
یک واحد سازمانی را به‌روزرسانی می‌کند.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
یک واحد سازمانی را به‌روزرسانی می‌کند.

منبع REST: امتیازات

روش‌ها
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
لیست صفحه‌بندی‌شده‌ای از تمام امتیازات یک مشتری را بازیابی می‌کند.

منبع REST: resources.buildings

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
یک ساختمان را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
یک ساختمان را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
ساختمانی را درج می‌کند.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
لیستی از ساختمان‌های یک حساب کاربری را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
یک ساختمان را وصله پینه می‌کند.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
یک ساختمان را به‌روزرسانی می‌کند.

منبع REST: resources.calendars

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
یک منبع تقویم را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
یک منبع تقویم را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
یک منبع تقویم درج می‌کند.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
فهرستی از منابع تقویم یک حساب کاربری را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
یک منبع تقویم را وصله می‌کند.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
یک منبع تقویم را به‌روزرسانی می‌کند.

منبع REST: resources.features

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
یک ویژگی را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
یک ویژگی را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customer}/resources/features
یک ویژگی را درج می‌کند.
list GET /admin/directory/v1/customer/{customer}/resources/features
لیستی از ویژگی‌های یک حساب کاربری را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
یک ویژگی را وصله می‌کند.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
یک ویژگی را تغییر نام می‌دهد.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
یک ویژگی را به‌روزرسانی می‌کند.

منبع REST: roleAssignments

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
یک نقش انتسابی را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
یک تکلیف نقشی را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
یک تکلیف نقش ایجاد می‌کند.
list GET /admin/directory/v1/customer/{customer}/roleassignments
لیست صفحه‌بندی شده‌ای از تمام وظایف نقش‌ها را بازیابی می‌کند.

منبع REST: نقش‌ها

روش‌ها
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
یک نقش را حذف می‌کند.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
نقشی را بازپس می‌گیرد.
insert POST /admin/directory/v1/customer/{customer}/roles
نقش ایجاد می‌کند.
list GET /admin/directory/v1/customer/{customer}/roles
لیست صفحه‌بندی‌شده‌ای از تمام نقش‌های موجود در یک دامنه را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
نقشی را وصله پینه می‌کند.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
یک نقش را به‌روزرسانی می‌کند.

منبع REST: طرحواره‌ها

روش‌ها
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
یک طرحواره را حذف می‌کند.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
یک طرحواره را بازیابی می‌کند.
insert POST /admin/directory/v1/customer/{customerId}/schemas
یک طرحواره ایجاد می‌کند.
list GET /admin/directory/v1/customer/{customerId}/schemas
تمام طرحواره‌های یک مشتری را بازیابی می‌کند.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
یک طرحواره را وصله می‌کند.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
یک طرحواره را به‌روزرسانی می‌کند.

منبع REST: توکن‌ها

روش‌ها
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
تمام توکن‌های دسترسی صادر شده توسط کاربر برای یک برنامه را حذف می‌کند.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
اطلاعات مربوط به توکن دسترسی صادر شده توسط کاربر را دریافت می‌کند.
list GET /admin/directory/v1/users/{userKey}/tokens
مجموعه‌ای از توکن‌هایی را که کاربر مشخص شده به برنامه‌های شخص ثالث صادر کرده است، برمی‌گرداند.

منبع REST: تأیید دو مرحله‌ای

روش‌ها
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
تأیید هویت دو مرحله‌ای را برای کاربر غیرفعال می‌کند.

منبع REST: کاربران

روش‌ها
delete DELETE /admin/directory/v1/users/{userKey}
یک کاربر را حذف می‌کند.
get GET /admin/directory/v1/users/{userKey}
یک کاربر را بازیابی می‌کند.
insert POST /admin/directory/v1/users
یک کاربر ایجاد می‌کند.
list GET /admin/directory/v1/users
لیست صفحه‌بندی‌شده‌ای از کاربران حذف‌شده یا تمام کاربران یک دامنه را بازیابی می‌کند.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
یک کاربر را به یک مدیر ارشد تبدیل می‌کند.
patch PATCH /admin/directory/v1/users/{userKey}
با استفاده از معانی وصله، یک کاربر را به‌روزرسانی می‌کند.
signOut POST /admin/directory/v1/users/{userKey}/signOut
کاربر را از تمام جلسات وب و دستگاه خارج می‌کند و کوکی‌های ورود به سیستم او را بازنشانی می‌کند.
undelete POST /admin/directory/v1/users/{userKey}/undelete
کاربر حذف شده را بازیابی می‌کند.
update PUT /admin/directory/v1/users/{userKey}
یک کاربر را به‌روزرسانی می‌کند.
watch POST /admin/directory/v1/users/watch
تغییرات در لیست کاربران را زیر نظر دارد.

منبع REST: users.aliases

روش‌ها
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
یک نام مستعار را حذف می‌کند.
insert POST /admin/directory/v1/users/{userKey}/aliases
یک نام مستعار اضافه می‌کند.
list GET /admin/directory/v1/users/{userKey}/aliases
تمام نام‌های مستعار یک کاربر را فهرست می‌کند.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
تغییرات در لیست کاربران را زیر نظر دارد.

منبع REST: users.photos

روش‌ها
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
عکس کاربر را حذف می‌کند.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
عکس کاربر را بازیابی می‌کند.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
یک عکس برای کاربر اضافه می‌کند.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
یک عکس برای کاربر اضافه می‌کند.

منبع REST: verificationCods

روش‌ها
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
کدهای تأیید پشتیبان جدیدی برای کاربر تولید می‌کند.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
کدهای تأیید پشتیبان فعلی را برای کاربر نامعتبر می‌کند.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
مجموعه فعلی کدهای تأیید پشتیبان معتبر را برای کاربر مشخص شده برمی‌گرداند.