Method: users.get

ユーザーを取得します。

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

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

パラメータ

パラメータ
`userKey`	`string` API リクエストでユーザーを識別します。この値は、ユーザーのメインのメールアドレス、エイリアスメールアドレス、または一意のユーザー ID です。

userKey

string

API リクエストでユーザーを識別します。この値は、ユーザーのメインのメールアドレス、エイリアスメールアドレス、または一意のユーザー ID です。

パラメータ

パラメータ
`customFieldMask`	`string` スキーマ名のカンマ区切りリスト。これらのスキーマからすべてのフィールドが取得されます。これは `projection=custom` の場合にのみ設定する必要があります。
`projection`	`enum (Projection)` このユーザーについて取得するフィールドのサブセット。
`viewType`	`enum (ViewType)` ユーザーの管理者権限またはドメイン全体の一般公開ビューを取得するかどうか。詳しくは、管理者以外のユーザーを取得するをご覧ください。

customFieldMask

string

スキーマ名のカンマ区切りリスト。これらのスキーマからすべてのフィールドが取得されます。これは projection=custom の場合にのみ設定する必要があります。

projection

このユーザーについて取得するフィールドのサブセット。

viewType

enum (ViewType)

ユーザーの管理者権限またはドメイン全体の一般公開ビューを取得するかどうか。詳しくは、管理者以外のユーザーを取得するをご覧ください。

リクエストの本文は空にする必要があります。

成功した場合、レスポンスの本文には User のインスタンスが含まれます。

次の OAuth スコープのいずれかが必要です。

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

予測

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

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