Method: users.get

사용자를 검색합니다.

HTTP 요청

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

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

경로 매개변수

매개변수
userKey

string

API 요청에서 사용자를 식별합니다. 값은 사용자의 기본 이메일 주소, 별칭 이메일 주소 또는 순 사용자 ID일 수 있습니다.

쿼리 매개변수

매개변수
customFieldMask

string

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

enum (Projection)

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

enum (ViewType)

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

요청 본문

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

응답 본문

성공한 경우 응답 본문에 User의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

자세한 내용은 승인 가이드를 참고하세요.

투영

열거형
BASIC 사용자의 맞춤 입력란은 포함하지 마세요.
CUSTOM customFieldMask에서 요청된 스키마의 맞춤 필드를 포함합니다.
FULL 이 사용자와 연결된 모든 필드를 포함합니다.

ViewType

열거형
admin_view 결과에는 사용자의 관리자 전용 필드와 도메인 공개 필드가 모두 포함됩니다.
domain_public 결과에는 도메인의 다른 사용자에게 공개적으로 표시되는 사용자의 필드만 포함됩니다.