Method: users.list

삭제된 사용자 또는 도메인의 모든 사용자 목록을 페이지로 나눈 목록으로 가져옵니다.

HTTP 요청

GET https://admin.googleapis.com/admin/directory/v1/users

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
customFieldMask

string

스키마 이름을 쉼표로 구분한 목록입니다. 이러한 스키마의 모든 필드가 가져옵니다. projection=custom인 경우에만 설정해야 합니다.
customer

string

고객의 Google Workspace 계정의 고유 ID입니다. 다중 도메인 계정의 경우 고객의 모든 사용자를 가져오려면 domain 대신 이 필드를 사용하세요. my_customer 별칭을 사용하여 계정의 customerId를 나타낼 수도 있습니다. customerId는 사용자 리소스의 일부로 반환되기도 합니다. customer 또는 domain 매개변수를 제공해야 합니다.
domain

string

도메인 이름 이 필드를 사용하여 하나의 도메인에서만 사용자를 가져옵니다. 고객 계정의 모든 도메인을 반환하려면 customer 쿼리 매개변수를 대신 사용하세요. customer 또는 domain 매개변수를 제공해야 합니다.
event

enum (Event)

구독하려는 이벤트 (구독하는 경우)
maxResults

integer

반환할 결과의 최대 수입니다.
orderBy

enum (OrderBy)

결과 정렬에 사용할 속성입니다.
pageToken

string

목록의 다음 페이지를 지정하는 토큰입니다. 페이지 토큰은 3일 동안만 유효합니다.
projection

enum (Projection)

이 사용자에 대해 가져올 필드의 하위 집합입니다.
query

string

사용자 필드를 검색하기 위한 쿼리 문자열입니다. 사용자 쿼리 구성에 관한 자세한 내용은 사용자 검색을 참고하세요.
showDeleted

string

true로 설정하면 삭제된 사용자 목록을 검색합니다. (기본값: false)
sortOrder

enum (SortOrder)

대소문자를 무시하고 결과를 오름차순 또는 내림차순으로 반환할지 지정합니다.
viewType

enum (ViewType)

사용자의 관리자 전용 보기 또는 도메인 전체 공개 보기를 가져올지 여부입니다. 자세한 내용은 비관리자로 사용자 검색하기를 참고하세요.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
필드
kind

string

리소스 유형입니다.
trigger_event

string

이 응답을 트리거한 이벤트입니다 (푸시 응답의 경우에만 사용됨).
etag

string

리소스의 ETag입니다.
users[]

object (User)

사용자 객체 목록입니다.
nextPageToken

string

이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다. 페이지 토큰은 3일 동안만 유효합니다.

승인 범위

다음 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 결과에는 도메인의 다른 사용자에게 공개적으로 표시되는 사용자의 필드만 포함됩니다.