삭제된 사용자 또는 도메인의 모든 사용자가 페이지로 나눈 목록을 검색합니다.
HTTP 요청
GET https://admin.googleapis.com/admin/directory/v1/users
URL은 gRPC 트랜스코딩 구문을 사용합니다.
쿼리 매개변수
매개변수 | |
---|---|
customFieldMask |
쉼표로 구분된 스키마 이름 목록입니다. 이 스키마의 모든 필드를 가져옵니다. |
customer |
고객 Google Workspace 계정의 고유 ID입니다. 여러 도메인 계정의 경우 한 고객의 모든 사용자를 가져오려면 |
domain |
도메인 이름입니다. 이 입력란을 사용하여 하나의 도메인에서만 사용자를 가져올 수 있습니다. 고객 계정의 모든 도메인을 반환하려면 대신 |
event |
구독이 필요한 이벤트 (구독하는 경우) |
maxResults |
반환할 결과의 최대 수입니다. |
orderBy |
결과 정렬에 사용할 속성입니다. |
pageToken |
목록의 다음 페이지를 지정하는 토큰입니다. |
projection |
이 사용자에 대해 가져올 필드의 하위 집합입니다. |
query |
사용자 필드 검색을 위한 쿼리 문자열입니다. 사용자 쿼리 생성에 대한 자세한 내용은 사용자 검색을 참조하세요. |
showDeleted |
|
sortOrder |
오름차순 또는 내림차순으로 결과를 반환할지(대소문자 무시). |
viewType |
사용자의 관리자 전용 공개 보기 또는 도메인 전체 공개 보기를 가져올지 여부입니다. 자세한 내용은 관리자가 아닌 사용자로서 사용자 검색을 참조하세요. |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
필드 | |
---|---|
kind |
리소스의 유형입니다. |
trigger_event |
이 응답을 트리거한 이벤트 (푸시 응답의 경우에만 사용됨) |
etag |
리소스의 eETag입니다. |
users[] |
사용자 객체의 목록입니다. |
nextPageToken |
이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다. |
승인 범위
다음 OAuth 범위 중 하나가 필요합니다.
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
자세한 내용은 승인 가이드를 참조하세요.
이벤트
구독 이벤트의 유형입니다.
열거형 | |
---|---|
ADD |
사용자 생성 이벤트 |
DELETE |
사용자 삭제 이벤트 |
MAKE_ADMIN |
사용자 관리자 상태 변경 이벤트 |
UNDELETE |
사용자 삭제 취소 이벤트 |
UPDATE |
사용자 업데이트 이벤트 |
OrderBy
열거형 | |
---|---|
EMAIL |
사용자의 기본 이메일입니다. |
FAMILY_NAME |
사용자의 성입니다. |
GIVEN_NAME |
사용자의 이름 |
투영
열거형 | |
---|---|
BASIC |
사용자에 대한 커스텀 필드를 포함하지 마세요. |
CUSTOM |
customFieldMask 에서 요청된 스키마의 맞춤 입력란을 포함합니다. |
FULL |
이 사용자와 연결된 모든 필드를 포함합니다. |
SortOrder
열거형 | |
---|---|
ASCENDING |
오름차순 |
DESCENDING |
내림차순입니다. |
ViewType
열거형 | |
---|---|
admin_view |
결과에는 사용자에 대한 관리자 전용 입력란과 도메인 공개 입력란이 모두 포함됩니다. |
domain_public |
결과에는 도메인의 다른 사용자에게 공개적으로 표시되는 사용자 입력란만 포함됩니다. |