인증된 사용자의 도메인 디렉터리에 있는 도메인 프로필 및 도메인 연락처 목록을 제공합니다.
가 지정되면 마지막 동기화 이후 삭제된 리소스가 syncToken
가 true로 설정된 사용자로 반환됩니다.PersonMetadata.deleted
또는 pageToken
가 지정되면 다른 모든 요청 매개변수가 첫 번째 호출과 일치해야 합니다.syncToken
동기화 요청의 경우 쓰기에 몇 분의 적용 지연이 있을 수 있습니다. 증분 동기화는 쓰기 후 읽기 사용 사례에 적합하지 않습니다.
사용 예시는 변경된 디렉터리 사용자 목록을 참고하세요.
HTTP 요청
GET https://people.googleapis.com/v1/people:listDirectoryPeople
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 | |
---|---|
readMask |
필수 항목입니다. 각 사용자의 어떤 필드가 반환되는지 제한하는 필드 마스크입니다. 쉼표로 구분하여 여러 필드를 지정할 수 있습니다. 유효한 값은 다음과 같습니다.
|
sources[] |
필수 항목입니다. 반환할 디렉터리 소스입니다. |
mergeSources[] |
선택사항입니다. 이메일 주소 또는 전화번호와 같은 확인된 조인 키를 통해 연결된 경우 디렉터리 소스에 병합할 추가 데이터입니다. |
pageSize |
선택사항입니다. 응답에 포함할 사용자 수입니다. 유효한 값은 1~1, 000입니다. 설정하지 않거나 0으로 설정하면 기본값은 100입니다. |
pageToken |
선택사항입니다. 이전 응답 페이지로 나눌 때 |
requestSyncToken |
선택사항입니다. 응답이 동기화 동작에 관한 자세한 내용은 |
syncToken |
선택사항입니다. 이전 응답 동기화할 때
|
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
인증된 사용자의 도메인 디렉터리 요청에 대한 응답입니다.
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
---|
{
"people": [
{
object ( |
필드 | |
---|---|
people[] |
도메인 디렉터리의 사용자 목록입니다. |
nextPageToken |
다음 페이지를 검색하기 위해 |
nextSyncToken |
마지막 요청 이후 변경사항을 가져오기 위해 |
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/directory.readonly
자세한 내용은 승인 가이드를 참고하세요.