Method: users.list

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

string

Şema adlarının virgülle ayrılmış listesi. Bu şemalardaki tüm alanlar getirilir. Bu ayar 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 kullanıcılarını getirmek için domain yerine bu alanı kullanın. Ayrıca, hesabınızın customerId ürününü temsil etmesi için my_customer takma adını da kullanabilirsiniz. customerId, Kullanıcılar 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ı elde etmek için bu alanı kullanın. Bir müşteri hesabına ait tüm alanları 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 (abone oluyorsanız)
maxResults

integer

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

enum (OrderBy)

Sonuçları sıralamak için kullanılacak mülk.
pageToken

string

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

enum (Projection)

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

string

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 konusuna bakın.
showDeleted

string

true olarak 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ği, büyük/küçük harf kullanımına bakılmaz.
viewType

enum (ViewType)

Kullanıcının yalnızca yönetici için mi yoksa alan genelinde herkese açık görünümünün mü getirileceği. Daha fazla bilgi edinmek için Bir kullanıcıyı yönetici olmayan bir kullanıcı olarak alma başlıklı makaleye göz atı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 (User)
    }
  ],
  "nextPageToken": string
}
Alanlar
kind

string

Bu, nasıl bir kaynak.
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 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ılavuzunu inceleyin.

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ı Etkinliği Silme İşlemi Geri Alındı
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 edin.
FULL Bu kullanıcıyla ilişkili tüm alanları dahil edin.

SortOrder

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

ViewType

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