Admin SDK: Directory API

Admin SDK Directory API memungkinkan administrator domain perusahaan melihat dan mengelola pengguna, grup, perangkat, dan resource terkait organisasi mereka. Cloud Identity API menawarkan cara tambahan untuk mengelola beberapa resource yang sama.

Layanan: admin.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi Anda perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat Anda membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca komputer untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen discovery berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan dapat memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah berhubungan dengan endpoint layanan ini:

  • https://admin.googleapis.com

REST Resource: asps

Metode
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
Menghapus ASP yang dikeluarkan oleh pengguna.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
Mendapatkan informasi tentang ASP yang dikeluarkan oleh pengguna.
list GET /admin/directory/v1/users/{userKey}/asps
Mencantumkan ASP yang diterbitkan oleh pengguna.

REST Resource: chromeosdevices

Metode
action
(deprecated)
POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
Sebagai gantinya, gunakan BatchChangeChromeOsDeviceStatus.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Mengambil properti perangkat Chrome OS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
Mengambil daftar perangkat Chrome OS yang di-pagination dalam akun.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
Memindahkan atau menyisipkan beberapa perangkat Chrome OS ke unit organisasi.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Memperbarui properti perangkat yang dapat diperbarui, seperti annotatedUser, annotatedLocation, notes, orgUnitPath, atau annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
Memperbarui properti perangkat yang dapat diperbarui, seperti annotatedUser, annotatedLocation, notes, orgUnitPath, atau annotatedAssetId.

Resource REST: customer.devices.chromeos

Metode
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
Mengubah status batch perangkat ChromeOS.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
Mengeluarkan perintah untuk dieksekusi perangkat.

Resource REST: customer.devices.chromeos.commands

Metode
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
Mendapatkan data perintah perintah tertentu yang dikeluarkan ke perangkat.

REST Resource: customers

Metode
get GET /admin/directory/v1/customers/{customerKey}
Mengambil pelanggan.
patch PATCH /admin/directory/v1/customers/{customerKey}
Menerapkan patch ke pelanggan.
update PUT /admin/directory/v1/customers/{customerKey}
Memperbarui pelanggan.

REST Resource: domainAliases

Metode
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Menghapus Alias domain pelanggan.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
Mengambil alias domain pelanggan.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
Menyisipkan alias domain pelanggan.
list GET /admin/directory/v1/customer/{customer}/domainaliases
Mencantumkan alias domain pelanggan.

REST Resource: domains

Metode
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
Menghapus domain pelanggan.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
Mengambil domain pelanggan.
insert POST /admin/directory/v1/customer/{customer}/domains
Menyisipkan domain pelanggan.
list GET /admin/directory/v1/customer/{customer}/domains
Mencantumkan domain pelanggan.

REST Resource: groups

Metode
delete DELETE /admin/directory/v1/groups/{groupKey}
Menghapus grup.
get GET /admin/directory/v1/groups/{groupKey}
Mengambil properti grup.
insert POST /admin/directory/v1/groups
Membuat grup.
list GET /admin/directory/v1/groups
Mengambil semua grup domain atau pengguna yang diberi userKey (di-pagination).
patch PATCH /admin/directory/v1/groups/{groupKey}
Memperbarui properti grup.
update PUT /admin/directory/v1/groups/{groupKey}
Memperbarui properti grup.

REST Resource: groups.aliases

Metode
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
Menghapus alias.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
Menambahkan alias untuk grup.
list GET /admin/directory/v1/groups/{groupKey}/aliases
Mencantumkan semua alias untuk grup.

REST Resource: members

Metode
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Menghapus anggota dari grup.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Mengambil properti anggota grup.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
Memeriksa apakah pengguna tertentu adalah anggota grup.
insert POST /admin/directory/v1/groups/{groupKey}/members
Menambahkan pengguna ke grup yang ditentukan.
list GET /admin/directory/v1/groups/{groupKey}/members
Mengambil daftar yang di-pagination dari semua anggota dalam grup.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Memperbarui properti keanggotaan pengguna dalam grup yang ditentukan.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
Memperbarui keanggotaan pengguna dalam grup yang ditentukan.

REST Resource: mobiledevices

Metode
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
Melakukan tindakan yang memengaruhi perangkat seluler.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Menghapus perangkat seluler.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
Mengambil properti perangkat seluler.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
Mengambil daftar yang di-pagination dari semua perangkat seluler milik pengguna untuk akun.

REST Resource: orgunits

Metode
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Menghapus unit organisasi.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Mengambil unit organisasi.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
Menambahkan unit organisasi.
list GET /admin/directory/v1/customer/{customerId}/orgunits
Mengambil daftar semua unit organisasi untuk akun.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Memperbarui unit organisasi.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
Memperbarui unit organisasi.

REST Resource: privileges

Metode
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
Mengambil daftar bernomor halaman dari semua hak istimewa untuk pelanggan.

Resource REST: resources.buildings

Metode
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Menghapus bangunan.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Mengambil bangunan.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
Menyisipkan bangunan.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
Mengambil daftar bangunan untuk akun.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Menerapkan patch ke bangunan.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
Memperbarui gedung.

Resource REST: resources.calendars

Metode
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Menghapus fasilitas kalender.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Mengambil fasilitas kalender.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
Menyisipkan fasilitas kalender.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
Mengambil daftar fasilitas kalender untuk akun.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Melakukan patch pada fasilitas kalender.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
Memperbarui fasilitas kalender.

Resource REST: resources.features

Metode
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Menghapus fitur.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Mengambil fitur.
insert POST /admin/directory/v1/customer/{customer}/resources/features
Menyisipkan fitur.
list GET /admin/directory/v1/customer/{customer}/resources/features
Mengambil daftar fitur untuk akun.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Menerapkan patch ke fitur.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
Mengganti nama fitur.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
Memperbarui fitur.

Resource REST: roleAssignments

Metode
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Menghapus penetapan peran.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
Mengambil penetapan peran.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
Membuat penetapan peran.
list GET /admin/directory/v1/customer/{customer}/roleassignments
Mengambil daftar bernomor halaman dari semua roleAssignments.

REST Resource: roles

Metode
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
Menghapus peran.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
Mengambil peran.
insert POST /admin/directory/v1/customer/{customer}/roles
Membuat peran.
list GET /admin/directory/v1/customer/{customer}/roles
Mengambil daftar yang di-pagination dari semua peran di domain.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
Menerapkan patch ke peran.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
Memperbarui peran.

Resource REST: schemas

Metode
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Menghapus skema.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Mengambil skema.
insert POST /admin/directory/v1/customer/{customerId}/schemas
Membuat skema.
list GET /admin/directory/v1/customer/{customerId}/schemas
Mengambil semua skema untuk pelanggan.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Menerapkan patch ke skema.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
Memperbarui skema.

REST Resource: tokens

Metode
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
Menghapus semua token akses yang dikeluarkan oleh pengguna untuk aplikasi.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
Mendapatkan informasi tentang token akses yang dikeluarkan oleh pengguna.
list GET /admin/directory/v1/users/{userKey}/tokens
Menampilkan kumpulan token yang telah dikeluarkan pengguna tertentu ke aplikasi pihak ketiga.

Resource REST: twoStepVerification

Metode
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
Menonaktifkan Verifikasi 2 Langkah untuk pengguna.

REST Resource: users

Metode
delete DELETE /admin/directory/v1/users/{userKey}
Menghapus pengguna.
get GET /admin/directory/v1/users/{userKey}
Mengambil pengguna.
insert POST /admin/directory/v1/users
Membuat pengguna.
list GET /admin/directory/v1/users
Mengambil daftar yang di-paging dari pengguna yang dihapus atau semua pengguna di domain.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
Membuat pengguna menjadi administrator super.
patch PATCH /admin/directory/v1/users/{userKey}
Memperbarui pengguna menggunakan semantik patch.
signOut POST /admin/directory/v1/users/{userKey}/signOut
Membuat pengguna logout dari semua sesi web dan perangkat serta mereset cookie loginnya.
undelete POST /admin/directory/v1/users/{userKey}/undelete
Mengembalikan pengguna yang dihapus.
update PUT /admin/directory/v1/users/{userKey}
Memperbarui pengguna.
watch POST /admin/directory/v1/users/watch
Memantau perubahan dalam daftar pengguna.

Resource REST: users.aliases

Metode
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
Menghapus alias.
insert POST /admin/directory/v1/users/{userKey}/aliases
Menambahkan alias.
list GET /admin/directory/v1/users/{userKey}/aliases
Mencantumkan semua alias untuk pengguna.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
Memantau perubahan dalam daftar pengguna.

Resource REST: users.photos

Metode
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
Menghapus foto pengguna.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
Mengambil foto pengguna.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
Menambahkan foto untuk pengguna.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
Menambahkan foto untuk pengguna.

Resource REST: verificationCodes

Metode
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
Membuat kode verifikasi cadangan baru untuk pengguna.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
Membatalkan validasi kode verifikasi cadangan saat ini untuk pengguna.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
Menampilkan kumpulan kode verifikasi cadangan yang valid saat ini untuk pengguna yang ditentukan.