Silinen kullanıcıların veya bir alandaki tüm kullanıcıların sayfalara ayrılmış bir listesini alır.
HTTP isteği
GET https://admin.googleapis.com/admin/directory/v1/users
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Sorgu parametreleri
Parametreler | |
---|---|
customFieldMask |
Şema adlarının virgülle ayrılmış listesi. Bu şemalardaki tüm alanlar getirilir. Bu, yalnızca |
customer |
Müşterinin Google Workspace hesabının benzersiz kimliği. Birden fazla alana sahip hesaplarda müşteri için tüm grupları getirmek üzere |
domain |
Alan adı. Grupları yalnızca bir alandan almak için bu alanı kullanın. Bir müşteri hesabındaki tüm alanları döndürmek için bunun yerine |
event |
Aboneliğin amaçlandığı etkinlik (aboneyseniz) |
maxResults |
Döndürülecek maksimum sonuç sayısı. |
orderBy |
Sonuçları sıralamak için kullanılacak özellik. |
pageToken |
Jeton, listedeki bir sonraki sayfayı belirtir |
projection |
Bu kullanıcı için getirilecek alanların alt kümesi. |
query |
Kullanıcı alanlarında arama yapmak için kullanılan sorgu dizesi. Kullanıcı sorguları oluşturma hakkında daha fazla bilgi için Kullanıcı Arama başlıklı makaleye göz atın. |
showDeleted |
|
sortOrder |
Sonuçların azalan veya azalan düzende döndürülüp döndürülmeyeceği (büyük/küçük harfe duyarlı değil). |
viewType |
Kullanıcının yalnızca yönetici veya alan genelinde herkese açık görünümünün getirilip getirilmeyeceği. Daha fazla bilgi için Bir kullanıcıyı yönetici olmayan olarak alma başlıklı makaleye bakın. |
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
Alanlar | |
---|---|
kind |
Bu kaynağın türü. |
trigger_event |
Bu yanıtı tetikleyen etkinlik (yalnızca Push Yanıtı durumunda kullanılır) |
etag |
Kaynağın eTag'i. |
users[] |
Kullanıcı nesnelerinin listesi. |
nextPageToken |
Bu sonucun sonraki sayfasına erişmek için kullanılan jeton. |
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
Etkinlik
Abonelik etkinliğinin türü
Sıralamalar | |
---|---|
ADD |
Kullanıcı Tarafından Oluşturulan Etkinlik |
DELETE |
Kullanıcı Tarafından Silinen Etkinlik |
MAKE_ADMIN |
Kullanıcı Yöneticisi Durum Değişikliği Etkinliği |
UNDELETE |
Kullanıcı Silme İşlemini Geri Alma |
UPDATE |
Kullanıcı Tarafından Güncellenen Etkinlik |
Sipariş Ver
Sıralamalar | |
---|---|
EMAIL |
Kullanıcının birincil e-posta adresi. |
FAMILY_NAME |
Kullanıcının soyadı. |
GIVEN_NAME |
Kullanıcıya verilen ad. |
Tahmin
Sıralamalar | |
---|---|
BASIC |
Kullanıcı için özel alanlar eklemeyin. |
CUSTOM |
customFieldMask ürününde istenen şemalardan özel alanlar ekleyin. |
FULL |
Bu kullanıcıyla ilişkili tüm alanları dahil edin. |
SortOrder
Sıralamalar | |
---|---|
ASCENDING |
Artan düzen. |
DESCENDING |
Azalan düzen. |
Görünüm Türü
Sıralamalar | |
---|---|
admin_view |
Sonuçlar, kullanıcının hem yönetici hem de alan adı herkese açık alanlarını içerir. |
domain_public |
Sonuçlar yalnızca kullanıcının diğer alanlardaki herkese açık alanlarını gösterir. |