削除されたユーザーまたはドメイン内のすべてのユーザーのページ分けされたリストを取得します。
HTTP リクエスト
GET https://admin.googleapis.com/admin/directory/v1/users
この URL は gRPC Transcoding 構文を使用します。
クエリ パラメータ
パラメータ | |
---|---|
customFieldMask |
スキーマ名のカンマ区切りのリスト。これらのスキーマからすべてのフィールドがフェッチされます。これは |
customer |
お客様の Google Workspace アカウントの一意の ID。マルチドメイン アカウントの場合、顧客のすべてのグループを取得するには、 |
domain |
ドメイン名。このフィールドを使用して、1 つのドメインからのみグループを取得できます。顧客アカウントのすべてのドメインを返すには、代わりに |
event |
定期購入するイベント(定期購入する場合) |
maxResults |
返される結果の最大数。 |
orderBy |
結果の並べ替えに使用するプロパティ。 |
pageToken |
リストの次のページを指定するトークン |
projection |
このユーザーに対して取得するフィールドのサブセット。 |
query |
ユーザー フィールドを検索するためのクエリ文字列。ユーザー クエリの構築について詳しくは、ユーザーを検索するをご覧ください。 |
showDeleted |
|
sortOrder |
結果を大文字と小文字の区別なしに昇順または降順で返します。 |
viewType |
ユーザーの管理者公開ビューのみを取得するか、ドメイン全体の公開ビューを取得するか。詳しくは、管理者以外のユーザーを取得するをご覧ください。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
フィールド | |
---|---|
kind |
リソースの種類。 |
trigger_event |
このレスポンスをトリガーしたイベント(push レスポンスの場合にのみ使用) |
etag |
リソースの ETag。 |
users[] |
ユーザー オブジェクトのリスト。 |
nextPageToken |
この結果の次のページへのアクセスに使用されるトークン。 |
認可スコープ
次の 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
詳しくは、OAuth 2.0 の概要をご覧ください。
イベント
サブスクリプション イベントのタイプ
列挙型 | |
---|---|
ADD |
ユーザー作成イベント |
DELETE |
ユーザー削除イベント |
MAKE_ADMIN |
ユーザー管理者ステータス変更イベント |
UNDELETE |
ユーザーの削除取り消しイベント |
UPDATE |
ユーザー更新イベント |
OrderBy
列挙型 | |
---|---|
EMAIL |
ユーザーのメインのメールアドレス。 |
FAMILY_NAME |
ユーザーの姓。 |
GIVEN_NAME |
ユーザーの名。 |
予測
列挙型 | |
---|---|
BASIC |
ユーザーのカスタム フィールドを含めないでください。 |
CUSTOM |
customFieldMask でリクエストされたスキーマのカスタム フィールドを含めます。 |
FULL |
このユーザーに関連付けられたすべてのフィールドを含めます。 |
SortOrder
列挙型 | |
---|---|
ASCENDING |
昇順。 |
DESCENDING |
降順。 |
ViewType
列挙型 | |
---|---|
admin_view |
結果には、そのユーザーの管理者専用フィールドとドメインの公開フィールドの両方が含まれます。 |
domain_public |
検索結果には、ドメイン内の他のユーザーに公開されているユーザーのフィールドのみが含まれます。 |