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

詳しくは、OAuth 2.0 の概要をご覧ください。

予測

列挙型
BASIC ユーザーのカスタム フィールドを含めないでください。
CUSTOM customFieldMask でリクエストされたスキーマのカスタム フィールドを含めます。
FULL このユーザーに関連付けられているすべてのフィールドを含めます。

ViewType

列挙型
admin_view 結果には、管理者専用のフィールドと、ドメインの一般公開フィールドの両方が含まれます。
domain_public 検索結果には、ドメイン内のユーザーが一般公開するフィールドのみが含まれます。