Admin SDK: Directory API

API Thư mục của SDK dành cho quản trị viên giúp quản trị viên của các miền của doanh nghiệp xem và quản lý người dùng, nhóm, thiết bị và các tài nguyên có liên quan trong tổ chức của họ. Các API Cloud Identity cung cấp thêm các cách quản lý một số tài nguyên tương tự.

Dịch vụ: admin.googleapis.com

Để gọi dịch vụ này, bạn nên sử dụng thư viện ứng dụng do Google cung cấp. Nếu ứng dụng của bạn cần sử dụng thư viện của riêng bạn để gọi dịch vụ này, hãy sử dụng thông tin sau đây khi đưa ra yêu cầu API.

Tài liệu khám phá

Tài liệu khám phá là một thông số kỹ thuật mà máy đọc được để mô tả và sử dụng các API REST. API này được dùng để xây dựng thư viện ứng dụng, trình bổ trợ IDE và các công cụ khác tương tác với các API của Google. Một dịch vụ có thể cung cấp nhiều tài liệu khám phá. Dịch vụ này cung cấp tài liệu khám phá sau đây:

Điểm cuối dịch vụ

Điểm cuối dịch vụ là một URL cơ sở chỉ định địa chỉ mạng của dịch vụ API. Một dịch vụ có thể có nhiều điểm cuối dịch vụ. Dịch vụ này có điểm cuối của dịch vụ sau đây và tất cả các URI bên dưới đều liên quan đến điểm cuối của dịch vụ này:

  • https://admin.googleapis.com

Tài nguyên REST: ASP

Phương thức
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
Xoá ASP do người dùng đưa ra.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Lấy thông tin về một ASP do người dùng cấp.
list GET /admin/directory/v1/users/{userKey}/asps
Liệt kê các ASP do người dùng đưa ra.

Tài nguyên REST: chromeos thiết bị

Phương thức
action
(deprecated)
POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
Sử dụng BatchChangeChromeOsDeviceStatus.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Truy xuất thuộc tính của thiết bị Chrome OS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Truy xuất danh sách các thiết bị Chrome OS đã phân trang trong một tài khoản.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Di chuyển hoặc chèn nhiều thiết bị ChromeOS vào một đơn vị tổ chức.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Cập nhật các thuộc tính có thể cập nhật của thiết bị, chẳng hạn như annotatedUser, annotatedLocation, notes, orgUnitPath hoặc annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Cập nhật các thuộc tính có thể cập nhật của thiết bị, chẳng hạn như annotatedUser, annotatedLocation, notes, orgUnitPath hoặc annotatedAssetId.

Tài nguyên REST: customer.devices.chromeos

Phương thức
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
Thay đổi trạng thái của một loạt thiết bị ChromeOS.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Đưa ra lệnh để thiết bị thực thi.

Tài nguyên REST: customer.devices.chromeos.commands

Phương thức
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
Lấy dữ liệu lệnh mà một lệnh cụ thể đã phát hành cho thiết bị.

Tài nguyên REST: khách hàng

Phương thức
get GET /admin/directory/v1/customers/{customerKey}
Truy xuất khách hàng.
patch PATCH /admin/directory/v1/customers/{customerKey}
Bản vá cho một khách hàng.
update PUT /admin/directory/v1/customers/{customerKey}
Cập nhật một khách hàng.

Tài nguyên REST: domainAliases

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Xoá Bí danh miền của khách hàng.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Truy xuất bí danh miền của khách hàng.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
Chèn một bí danh miền của khách hàng.
list GET /admin/directory/v1/customer/{customer}/domainaliases
Liệt kê bí danh miền của khách hàng.

Tài nguyên REST: domains

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
Xoá miền của khách hàng.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
Truy xuất miền của khách hàng.
insert POST /admin/directory/v1/customer/{customer}/domains
Chèn một miền của khách hàng.
list GET /admin/directory/v1/customer/{customer}/domains
Liệt kê các miền của khách hàng.

Tài nguyên REST: groups

Phương thức
delete DELETE /admin/directory/v1/groups/{groupKey}
Xoá nhóm.
get GET /admin/directory/v1/groups/{groupKey}
Truy xuất các thuộc tính của nhóm.
insert POST /admin/directory/v1/groups
Tạo nhóm.
list GET /admin/directory/v1/groups
Truy xuất tất cả các nhóm của một miền hoặc của một người dùng đã cung cấp một khoá người dùng (đã phân trang).
patch PATCH /admin/directory/v1/groups/{groupKey}
Cập nhật các thuộc tính của nhóm.
update PUT /admin/directory/v1/groups/{groupKey}
Cập nhật các thuộc tính của nhóm.

Tài nguyên REST: groups.aliases

Phương thức
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
Xoá một bí danh.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
Thêm bí danh cho nhóm.
list GET /admin/directory/v1/groups/{groupKey}/aliases
Liệt kê tất cả các email đại diện của một nhóm.

Tài nguyên REST: thành viên

Phương thức
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Xoá một thành viên khỏi nhóm.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Truy xuất thuộc tính của thành viên nhóm.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Kiểm tra xem người dùng đã cho có phải là thành viên của nhóm hay không.
insert POST /admin/directory/v1/groups/{groupKey}/members
Thêm người dùng vào nhóm đã chỉ định.
list GET /admin/directory/v1/groups/{groupKey}/members
Truy xuất danh sách đã phân trang của tất cả thành viên trong một nhóm.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Cập nhật các thuộc tính thành viên của người dùng trong nhóm được chỉ định.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Cập nhật tư cách thành viên của người dùng trong nhóm được chỉ định.

Tài nguyên REST: mobiledevices

Phương thức
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
Thực hiện một hành động ảnh hưởng đến thiết bị di động.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Xoá thiết bị di động.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Truy xuất các thuộc tính của thiết bị di động.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Truy xuất danh sách đã phân trang gồm tất cả các thiết bị di động do người dùng sở hữu cho một tài khoản.

Tài nguyên REST: orgunits

Phương thức
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Xoá một đơn vị tổ chức.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Truy xuất một đơn vị tổ chức.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
Thêm một đơn vị tổ chức.
list GET /admin/directory/v1/customer/{customerId}/orgunits
Truy xuất danh sách tất cả các đơn vị tổ chức của một tài khoản.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Cập nhật một đơn vị tổ chức.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Cập nhật một đơn vị tổ chức.

Tài nguyên REST: đặc quyền

Phương thức
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
Truy xuất danh sách đã phân trang gồm tất cả các đặc quyền của một khách hàng.

Tài nguyên REST: resources.buildings

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Xoá một toà nhà.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Truy xuất một toà nhà.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
Chèn một toà nhà.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
Truy xuất danh sách toà nhà cho một tài khoản.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Vạch cho một toà nhà.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Cập nhật một toà nhà.

Tài nguyên REST: resources.calendars

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Xoá tài nguyên lịch.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Truy xuất tài nguyên lịch.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
Chèn một tài nguyên lịch.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
Truy xuất danh sách tài nguyên lịch cho một tài khoản.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Bản vá một tài nguyên lịch.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Cập nhật tài nguyên lịch.

Tài nguyên REST: resources.features

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Xoá một đối tượng.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Truy xuất một tính năng.
insert POST /admin/directory/v1/customer/{customer}/resources/features
Chèn một tính năng.
list GET /admin/directory/v1/customer/{customer}/resources/features
Truy xuất danh sách tính năng của tài khoản.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Bản vá một tính năng.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Đổi tên một tính năng.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Cập nhật một tính năng.

Tài nguyên REST: roleAssignments

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Xoá vai trò đã chỉ định.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Truy xuất thông tin chỉ định vai trò.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
Tạo chỉ định vai trò.
list GET /admin/directory/v1/customer/{customer}/roleassignments
Truy xuất danh sách đã phân trang của tất cả dịch vụ vai trò.

Tài nguyên REST: vai trò

Phương thức
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
Xoá một vai trò.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
Truy xuất một vai trò.
insert POST /admin/directory/v1/customer/{customer}/roles
Tạo một vai trò.
list GET /admin/directory/v1/customer/{customer}/roles
Truy xuất danh sách đã phân trang gồm tất cả các vai trò trong miền.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
Bản vá một vai trò.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
Cập nhật một vai trò.

Tài nguyên REST: lược đồ

Phương thức
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Xoá một giản đồ.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Truy xuất giản đồ.
insert POST /admin/directory/v1/customer/{customerId}/schemas
Tạo giản đồ.
list GET /admin/directory/v1/customer/{customerId}/schemas
Truy xuất tất cả giản đồ cho một khách hàng.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Bản vá một giản đồ.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Cập nhật một giản đồ.

Tài nguyên REST: mã thông báo

Phương thức
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
Xoá tất cả mã truy cập mà người dùng cấp cho một ứng dụng.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
Lấy thông tin về mã truy cập do người dùng cấp.
list GET /admin/directory/v1/users/{userKey}/tokens
Trả về tập hợp mã thông báo do người dùng chỉ định đã cấp cho các ứng dụng của bên thứ ba.

Tài nguyên REST: twoStepVerification

Phương thức
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Tắt tính năng Xác minh 2 bước cho người dùng.

Tài nguyên REST: người dùng

Phương thức
delete DELETE /admin/directory/v1/users/{userKey}
Xoá người dùng.
get GET /admin/directory/v1/users/{userKey}
Truy xuất người dùng.
insert POST /admin/directory/v1/users
Tạo một người dùng.
list GET /admin/directory/v1/users
Truy xuất danh sách đã phân trang gồm người dùng đã bị xoá hoặc tất cả người dùng trong một miền.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Chọn người dùng làm quản trị viên cấp cao.
patch PATCH /admin/directory/v1/users/{userKey}
Cập nhật người dùng bằng cách sử dụng ngữ nghĩa bản vá.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Đăng xuất người dùng khỏi tất cả các phiên trên web và thiết bị, đồng thời đặt lại cookie đăng nhập của họ.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Khôi phục người dùng đã bị xoá.
update PUT /admin/directory/v1/users/{userKey}
Cập nhật người dùng.
watch POST /admin/directory/v1/users/watch
Theo dõi các thay đổi trong danh sách người dùng.

Tài nguyên REST: users.aliases

Phương thức
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
Xoá một bí danh.
insert POST /admin/directory/v1/users/{userKey}/aliases
Thêm bí danh.
list GET /admin/directory/v1/users/{userKey}/aliases
Liệt kê tất cả các email đại diện của một người dùng.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Theo dõi các thay đổi trong danh sách người dùng.

Tài nguyên REST: users.photos

Phương thức
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Xoá ảnh của người dùng.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
Truy xuất ảnh của người dùng.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
Thêm ảnh cho người dùng.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
Thêm ảnh cho người dùng.

Tài nguyên REST: verificationCodes

Phương thức
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
Tạo mã xác minh dự phòng mới cho người dùng.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Vô hiệu hoá các mã xác minh dự phòng hiện tại cho người dùng.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Trả về tập hợp mã xác minh dự phòng hợp lệ hiện tại cho người dùng được chỉ định.