Method: users.list

Bir alandaki silinmiş kullanıcıların veya tüm kullanıcıların sayfalandırı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

string

Şema adlarının virgülle ayrılmış listesi. Bu şemalardaki tüm alanlar getirilir. Bu yalnızca projection=custom olduğunda ayarlanmalıdır.
customer

string

Müşterinin Google Workspace hesabının benzersiz kimliği. Birden fazla alan adına sahip bir hesap söz konusu olduğunda, bir müşterinin tüm gruplarını getirmek için domain yerine bu alanı kullanın. Hesabınızın customerId kimliğini temsil etmek için my_customer takma adını da kullanabilirsiniz. customerId öğesi de Kullanıcılar kaynağının bir parçası olarak döndürülür. customer veya domain parametresini sağlamanız gerekir.
domain

string

Alan adı. Yalnızca tek bir alandan grup almak için bu alanı kullanın. Bir müşteri hesabının tüm alanlarını döndürmek için bunun yerine customer sorgu parametresini kullanın. customer veya domain parametresi sağlanmalıdır.
event

enum (Event)

Aboneliğin amaçlandığı etkinlik (abonelik durumunda)
maxResults

integer

Döndürülecek maksimum sonuç sayısı.
orderBy

enum (OrderBy)

Sonuçları sıralamak için kullanılacak özellik.
pageToken

string

Listede sonraki sayfayı belirtmek için kullanılan jeton
projection

enum (Projection)

Bu kullanıcı için getirilecek alan alt kümesi.
query

string

Kullanıcı alanlarında arama yapmak için sorgu dizesi. Kullanıcı sorguları oluşturma hakkında daha fazla bilgi edinmek için Kullanıcı Arama başlıklı yardım makalesine bakın.
showDeleted

string

true değerine ayarlanırsa silinen kullanıcıların listesini getirir. (Varsayılan: false)
sortOrder

enum (SortOrder)

Sonuçların artan veya azalan düzende döndürülüp döndürülmeyeceğini belirtir. Büyük/küçük harf kullanımı göz ardı edilir.
viewType

enum (ViewType)

Kullanıcının yalnızca yönetici veya alan genelinde herkese açık görünümünün getirilip getirilmeyeceğini belirler. Daha fazla bilgi için Bir kullanıcıyı yönetici olmayan kullanıcı olarak geri alma başlıklı makaleyi inceleyin.

İ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 (User)
    }
  ],
  "nextPageToken": string
}
Alanlar
kind

string

Bu, bir tür kaynak.
trigger_event

string

Bu yanıtı tetikleyen etkinlik (yalnızca Push Yanıtı durumunda kullanılır)
etag

string

Kaynağın ETag.
users[]

object (User)

Kullanıcı nesnelerinin bir listesi.
nextPageToken

string

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ılavuzu'na bakın.

Etkinlik

Abonelik etkinliğinin türü

Sıralamalar
ADD Kullanıcı Tarafından Oluşturulan Etkinlik
DELETE Kullanıcı Etkinliği Silindi
MAKE_ADMIN Kullanıcı Yöneticisi Durum Değişikliği Etkinliği
UNDELETE Kullanıcı Etkinliğini Geri Aldı
UPDATE Kullanıcı Tarafından Güncellenen Etkinlik

OrderBy

Sıralamalar
EMAIL Kullanıcının birincil e-posta adresi.
FAMILY_NAME Kullanıcının soyadı.
GIVEN_NAME Kullanıcının adı.

Projeksiyon

Sıralamalar
BASIC Kullanıcı için herhangi bir özel alan eklemeyin.
CUSTOM customFieldMask içinde istenen şemalardaki özel alanları dahil et.
FULL Bu kullanıcıyla ilişkilendirilen tüm alanları dahil et.

SortOrder

Sıralamalar
ASCENDING Artan düzende.
DESCENDING Azalan sırada.

ViewType

Sıralamalar
admin_view Sonuçlar, kullanıcıya ilişkin hem yalnızca yönetici hem de alan herkese açık alanlarını içerir.
domain_public Sonuçlar, yalnızca alandaki diğer kullanıcılara görünür olan kullanıcı alanlarını içerir.