Zawiera listę profili domen i kontaktów domeny w katalogu domeny uwierzytelnionego użytkownika.
Jeśli zasada
jest określona, zasoby usunięte od czasu ostatniej synchronizacji są zwracane jako osoba, dla której zasada syncToken
ma wartość Prawda.PersonMetadata.deleted
Jeśli podasz parametr
lub pageToken
, wszystkie pozostałe parametry żądania muszą być zgodne z pierwszym wywołaniem.syncToken
W przypadku żądań synchronizacji zapisywanie może być opóźnione o kilka minut. Synchronizacja przyrostowa nie jest przeznaczona do obsługi odczytu po zapisie.
Przykładowe zastosowanie znajdziesz w sekcji Wyświetlanie listy osób, które zostały zmienione w katalogu.
Żądanie HTTP
GET https://people.googleapis.com/v1/people:listDirectoryPeople
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
Parametry | |
---|---|
readMask |
Wymagane. Maska pola, która ogranicza, które pola dotyczące danej osoby mają być zwracane. Aby podać wiele pól, rozdziel je przecinkami. Prawidłowe wartości to:
|
sources[] |
Wymagane. Źródła katalogów do zwrócenia. |
mergeSources[] |
Opcjonalnie: Dodatkowe dane do scalenia ze źródłami katalogów, jeśli są połączone za pomocą zweryfikowanych kluczy łączenia, takie jak adresy e-mail lub numery telefonów. |
pageSize |
Opcjonalnie: Liczba osób, które mają zostać uwzględnione w odpowiedzi. Prawidłowe wartości to od 1 do 1000 włącznie. Jeśli nie zostanie ustawiony lub zostanie ustawiony na 0, domyślna wartość to 100. |
pageToken |
Opcjonalnie: Token strony otrzymany z poprzedniej odpowiedzi Podczas podziału na strony wszystkie inne parametry przekazane do funkcji |
requestSyncToken |
Opcjonalnie: Określa, czy odpowiedź powinna zwracać Więcej informacji o sposobie synchronizacji znajdziesz na stronie |
syncToken |
Opcjonalnie: token synchronizacji otrzymany z poprzedniej odpowiedzi ( Podczas synchronizacji wszystkie pozostałe parametry podane w usłudze Więcej informacji o zachowaniu synchronizacji znajdziesz na stronie |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź na żądanie dotyczące katalogu domeny uwierzytelnionego użytkownika.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"people": [
{
object ( |
Pola | |
---|---|
people[] |
Lista osób w katalogu domeny. |
nextPageToken |
token, który może być wysyłany jako |
nextSyncToken |
token, który można wysłać jako |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/directory.readonly
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.