Method: users.list

Silinen kullanıcıların veya bir alandaki 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ı içeren bir hesap söz konusu olduğunda, bir müşterinin tüm kullanıcılarını almak için domain yerine bu alanı kullanın. Hesabınızın customerId değerini temsil etmek için my_customer takma adını da kullanabilirsiniz. customerId, Users kaynağının bir parçası olarak da döndürülür. customer veya domain parametresini sağlamanız gerekir.
domain

string

Alan adı. Yalnızca bir alandan kullanıcı 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 hedeflendiği etkinlik (abone oluyorsanız)
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 jeton. Sayfa jetonu yalnızca üç gün boyunca geçerlidir.
projection

enum (Projection)

Bu kullanıcı için hangi alan alt kümesinin getirileceği.
query

string

Kullanıcı alanlarını aramak için sorgu dizesi. Kullanıcı sorguları oluşturma hakkında daha fazla bilgi için Kullanıcı arama başlıklı makaleyi inceleyin.
showDeleted

string

true olarak ayarlanırsa silinen kullanıcıların listesini alır. (Varsayılan: false)
sortOrder

enum (SortOrder)

Büyük/küçük harf farkı gözetilmeksizin sonuçların artan veya azalan düzende döndürüleceğini belirtir.
viewType

enum (ViewType)

Kullanıcının yalnızca yöneticilere açık olan görünümünü mi yoksa alan genelinde herkese açık görünümünü mü getireceğini belirtir. Daha fazla bilgi için Yönetici olmayan bir kullanıcıyı 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 kaynağın türü.
trigger_event

string

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

string

Kaynağın ETag'i.
users[]

object (User)

Kullanıcı nesnelerinin listesi.
nextPageToken

string

Bu sonucun bir sonraki sayfasına erişmek için kullanılan jeton. Sayfa jetonu yalnızca üç gün boyunca geçerlidir.

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ı Silme Etkinliği
MAKE_ADMIN Kullanıcı Yönetici Durumu Değişiklik Etkinliği
UNDELETE Kullanıcının Silme İşlemini Geri Alma Etkinliği
UPDATE Kullanıcı Güncellenen Etkinlik

Şuna göre sırala

Sıralamalar
EMAIL Kullanıcının birincil e-postası.
FAMILY_NAME Kullanıcının soyadı.
GIVEN_NAME Kullanıcıya verilen ad.

Projeksiyon

Sıralamalar
BASIC Kullanıcı için özel alan eklemeyin.
CUSTOM customFieldMask'te istenen şemalardaki özel alanları ekleyin.
FULL Bu kullanıcıyla ilişkili tüm alanları ekleyin.

SortOrder

Sıralamalar
ASCENDING Artan düzen.
DESCENDING Azalan düzen.

ViewType

Sıralamalar
admin_view Sonuçlar, kullanıcı için hem yalnızca yöneticiye açık hem de alanda herkese açık alanları içerir.
domain_public Sonuçlar yalnızca kullanıcının alandaki diğer kullanıcılar tarafından herkese açık olarak görülebilen alanlarını içerir.