Method: users.get

ユーザーを取得します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 結果には、ドメイン内の他のユーザーが一般公開できるユーザーのフィールドのみが含まれます。