Admin SDK: Directory API

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

خدمات: admin.googleapis.com

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

سند کشف

Discovery Document یک ویژگی قابل خواندن توسط ماشین برای توصیف و مصرف API های REST است. از آن برای ساخت کتابخانه های سرویس گیرنده، پلاگین های IDE و سایر ابزارهایی که با Google 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}
ویژگی های دستگاه سیستم عامل Chrome را بازیابی می کند.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
فهرست صفحه بندی شده ای از دستگاه های سیستم عامل Chrome را در یک حساب بازیابی می کند.
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 را تغییر می دهد.
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: group.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
یک لیست صفحه بندی شده از تمام 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: twoStepVerification

مواد و روش ها
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
تأیید صحت 2 مرحله ای را برای کاربر خاموش می کند.

منبع 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}
کاربر را با استفاده از Patch semantics به روز می کند.
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: verificationCodes

مواد و روش ها
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
مجموعه فعلی کدهای تأیید پشتیبان معتبر را برای کاربر مشخص شده برمی‌گرداند.