ユーザーを検索する

Google Workspaceのユーザーを検索します。

この操作は、同一接続ドメインの一部であるユーザーに対して実行されます。

オプション

フィールド 定義 タイプ 必須
Return（結果） 検索結果を表示するために次のオプションのいずれかを選択します。

  • First Matching Record（最初に一致したレコード）：単一のレコードが返されます。

  • First 100 Matching Records（最初に一致した100レコード）：最初に一致した100件のレコードをリスト形式で返します

  • Stream Matching Records（一致レコードのストリーミング）：一致したすべてのレコードを親フローからヘルパーフローに渡します。カードに［Streaming（ストリーミング）］入力セクションが追加され、カスタム拡張可能フィールドのストリーミングと追加のためのヘルパーフローを選択できます。

 ドロップダウン TRUE

入力

フィールド 定義 タイプ 必須
Search By（検索条件）
名前 ユーザーの名前。 文字列 FALSE
メール ユーザーのメールアドレス。 文字列 FALSE
First Name（名） ユーザーの名。 文字列 FALSE
Last Name（姓） ユーザーの姓。 文字列 FALSE
Is Admin?（管理者？） ユーザーがスーパー管理者権限を持っているかどうかを示します（このフィールドはユーザーを管理者にするアクションでのみ編集できます）。 ブール値 FALSE
Is Delegated Admin?（代理管理者？） ユーザーが代理管理者であるかどうかを示します。代理管理者はAPIによってサポートされていますが、ユーザーの作成または復活を行ったりユーザーを管理者にしたりすることはできません。こうしたリクエストはAPIサービスによって無視されます。管理者のロールおよび権限はAdmin Consoleを使用して割り当てられます。 ブール値 FALSE
Is Suspended?（保留？） ユーザーが保留されているかどうかを示します。 ブール値 FALSE
IM Network ID（IMネットワークID） ユーザーのIMアカウント（ユーザーは複数のIMアカウントを持つことができますが、プライマリーは1つのみです）。 文字列 FALSE
External ID（外部ID）

ユーザーの一意の外部ID。

 文字列 FALSE
Manager Email（マネージャーメール） ユーザーのマネージャーのメールアドレス。 文字列 FALSE
Manager ID（マネージャーID） ユーザーのマネージャーの一意識別子。 文字列 FALSE
Direct Manager Email（直接マネージャーメール） ユーザーの直接マネージャーのメールアドレス。 文字列 FALSE
Direct Manager ID (直接マネージャーID) ユーザーの直接マネージャーの一意識別子。 文字列 FALSE
Address（住所） ユーザーの住所。 文字列 FALSE
Address Street（住所の番地） ユーザーの住所の番地部分。 文字列 FALSE
Address PO Box（住所の私書箱） ユーザーの私書箱。 文字列 FALSE
Address City（住所の市） ユーザーの住所の市。 文字列 FALSE
Address Region（住所の都道府県） ユーザーの住所の都道府県。 文字列 FALSE
Address Postal Code（住所の郵便番号） ユーザーの住所の郵便番号。 文字列 FALSE
Address Country（住所の国） ユーザーの住所の国。 文字列 FALSE
Organization Name Organizationの名前。 文字列 FALSE
Organization Department（Organizationの部門） ユーザーが関連付けられたOrganization内の部門（たとえば、販売または技術など）。 文字列 FALSE
Organization Description（Organizationの説明） Organizationの説明。 文字列 FALSE
Organization Cost Center（Organizationのコストセンター） Organizationのコストセンター。 文字列 FALSE
Phone（電話） Organizationの電話番号。 文字列 FALSE
Organizational Unit Path（Organization単位パス） ユーザーに関連付けられている組織への完全パス。パスには先頭のスラッシュ（/）が必要です。これがない場合、400「不正リクエスト」メッセージが返されます。
たとえば、/corp/sales/sales_supportであれば、親パスは/corp/salesです。

Organizationキーは必要ありません。

 文字列 FALSE
Is Enrolled in 2SV?（2SVで登録？） ユーザーが2段階検証で登録されるかどうかを示します。 文字列 FALSE
Is Enforced in 2SV?（2SVを強制？） ユーザーに2段階検証が強制されるかどうかを示します。 文字列 FALSE
Custom Schema Name（カスタムスキーマ名） ユーザーのカスタムスキーマ。 文字列 FALSE
Custom Field Name（カスタムフィールド名） ユーザーのカスタムフィールド。 文字列 FALSE
Search Criteria（検索条件）
Record Limit（レコード制限） ストリーミングするレコードの数を指定します。

  • ［Limit（限度）］フィールドが0より大きい値に設定されている場合、0より大きい件数で指定されたレコードの最大件数以下のレコードが返されます。

  • ［Limit（限度）］フィールドが空または選択されていない場合、すべてのレコードがストリーミングされます。

  • デフォルト値は1,000万です。

  • 有効な範囲は1～1,000万です。

［Result Set（結果セット）］オプションで［Stream Matching Records（一致レコードのストリーミング）］ が選択されている場合に表示されます。

 数値 FALSE
Streaming（ストリーミング）
Flow（フロー）

［Choose Flow（フローの選択）］をクリックし、検索結果がストリーミングされるヘルパーフローを参照および選択して、［Choose（選択）］をクリックして確定します。

オプションとして、[Click or drop here to create (クリックまたはここにドロップして作成)]の下の空のフィールドをクリックし、データをヘルパーフローに渡すカスタム拡張可能フィールドを追加します。これらのフィールドは、ヘルパーフロー内の[State (状態)]出力オブジェクトの下にキーと値のペアとして追加されます。

 フロー TRUE

出力

フィールド 定義 タイプ
結果
User ID（ユーザーID） ユーザーの一意識別子。 文字列
ETag リソースのETag。 文字列
First Name（名） ユーザーの名。 文字列
Last Name（姓） ユーザーの姓。 文字列
Notes（注記） ユーザーのメモ。 文字列
Is Admin?（管理者？） ユーザーがスーパー管理者権限を持っているかどうかを示します（このフィールドはユーザーを管理者にするアクションでのみ編集できます）。 ブール値
Is Delegated Admin?（代理管理者？） ユーザーが代理管理者であるかどうかを示します。代理管理者はAPIによってサポートされていますが、ユーザーの作成または復活を行ったりユーザーを管理者にしたりすることはできません。こうしたリクエストはAPIサービスによって無視されます。管理者のロールおよび権限はAdmin Consoleを使用して割り当てられます。 ブール値
Change Password At Next Login?（次回ログオン時にパスワードを変更？） ユーザーが次回ログオン時にパスワードの変更を強制されるかどうかを示します（サードパーティーのIDプロバイダーを使用してSSOが構成される場合は適用されません）。 ブール値
Agreed to Terms?（条件に同意？） ユーザーが初期ログインを完了し、サービス契約の条件に同意したかどうかを示します。 ブール値
IP Allow Listed?（IPリストを許可？） ユーザーのIPアドレスの一覧表示が許可されるかどうかを示します。 ブール値
Suspended?（保留？） ユーザーが保留されているかどうかを示します。 ブール値
Suspension Reason（保留の理由） ユーザーが、管理者またはGoogleによって保留された理由。オプションはABUSE、ADMIN、UNDER13、またはWEB_LOGIN_REQUIREDです。 文字列
Organizational Unit Path（Organization単位パス）

ユーザーに関連付けられている組織への完全パス。

ユーザーがアクセスできるGoogle Workspaceサービスは、ユーザーの組織単位によって決まります。ユーザーが新しいOrganizationに移動すると、ユーザーのアクセス権は変更されます。

完全パスには先頭のスラッシュ（/）が必要です。

たとえば、Organization単位が/corp/salesの下のsales_supportであれば、Organization単位の完全パスは/sales/sales_supportとなります。corp（Organizationキー）は必要ありません。

 文字列
Customer ID (顧客ID) すべてのアカウントユーザーを取得するための顧客ID。 文字列
Is Enrolled in 2SV?（2SVで登録？） ユーザーが2段階検証で登録されるかどうかを示します。 ブール値
Is Enforced in 2SV?（2SVを強制？） ユーザーに2段階検証が強制されるかどうかを示します。 ブール値
Is Mailbox Setup?（メールボックスのセットアップ？） ユーザーのGoogleメールボックスが作成されているかどうかを示します。 ブール値
Custom Fields（カスタムフィールド） ユーザーのカスタムスキーマに存在するすべてのフィールド。 文字列
Aliases（エイリアス） エイリアスメールアドレス。 文字列のリスト
IMs（IM）
IM Network ID（IMネットワークID） ユーザーのIMアカウント（ユーザーは複数のIMアカウントを持つことができますが、プライマリーは1つのみです）。 文字列
タイプ IMアカウントタイプ：

  • home

  • work

  • custom

  • other

 文字列
Custom Type（カスタムタイプ） 必須。IMタイプがcustomの場合はユーザー定義値。 文字列
Protocol（プロトコル） IMネットワーク（カスタムネットワークまたは標準ネットワーク）。 文字列
Custom Protocol（カスタムプロトコル） 必須。プロトコルがcustomの場合はユーザー定義値。 文字列
Primary?（プライマリー？） これがユーザーのプライマリーIMであるかどうかを示します。 ブール値
Emails (メール)
Email Address（メールアドレス） ユーザーのメールアドレス。 文字列
タイプ メールアカウントタイプ：

  • home

  • work

  • custom

  • other

 ドロップダウン
Custom Type（カスタムタイプ） 必須。メールアドレスタイプの選択がcustomの場合はユーザー定義値。 文字列
Primary?（プライマリー？） これがユーザーのプライマリーメールアドレスであるかどうかを示します。 ブール値
External IDs（外部ID）
External ID（外部ID） IDの値。 文字列
タイプ 外部IDのタイプ：

  • account

  • custom

  • customer

  • login_ID

  • network

  • organization

 文字列
Custom Type（カスタムタイプ） 必須。アドレスタイプの選択がcustomの場合はユーザー定義値。 文字列
Relations (関連)
Relation Name（関連名） ユーザーが関連する人の名前。 文字列
タイプ 関連のタイプ：

  • admin_assistant

  • assistant

  • brother

  • child

  • custom

  • domestic_partner

  • dotted_line_manager

  • exec_assistant

  • father

  • friend

  • manager

  • mother

  • parent

  • partner

  • referred_by

  • relative

  • sister

  • spouse

 文字列
Custom Type（カスタムタイプ） 必須。タイプがカスタムの場合はユーザー定義値。 文字列
Addresses (住所)
Street（番地） ユーザーの住所の番地部分。 文字列
PO Box（私書箱） ユーザーの私書箱。 文字列
City（市町村） ユーザーの住所の市。 文字列
Region（リージョン） ユーザーの住所の都道府県。 文字列
国 ユーザーの住所の国。 文字列
国コード ユーザーの住所の国の電話プレフィックス（ISO 3166-1標準）。 文字列
Extended Address（拡張住所） 小地域を含む住所の拡張フィールド。 文字列
Formatted Address（フォーマット済み住所） 住所の形式化版。 文字列
タイプ 住所のタイプ：
  • home
  • work
  • custom
  • other
 ドロップダウン
Custom Type（カスタムタイプ） 必須。アドレスタイプの選択がcustomの場合はユーザー定義値。 文字列
Primary?（プライマリー？） これがユーザーのプライマリー住所かどうかを示します。 ブール値
Organizations
Organization Name Organizationの名前。 文字列
説明 Organizationの説明。 文字列
Department（部門） ユーザーが関連付けられたOrganization内の部門（たとえば、販売または技術など）。 文字列
Job Title（役職名） ユーザーのOrganization内の役職名（たとえば、メンバーまたはエンジニアなど）。 文字列
Location（場所） Organizationの物理的な場所（これは住所である必要はありません）。 文字列
Symbol（シンボル） Organizationのテキスト文字列シンボル（たとえば、GoogleのシンボルはGOOGです）。 文字列
Cost Center（コストセンター） ユーザーのOrganizationのコストセンター。 文字列
ドメイン Organizationが属するドメイン。 文字列
タイプ Organizationのタイプ。 文字列
Custom Type（カスタムタイプ） 必須。アドレスタイプの選択がcustomの場合はユーザー定義値。 文字列
Primary?（プライマリー？） これがユーザーのプライマリーOrganizationであるかどうかを示します。 ブール値
Phones (電話)
Phone Number（電話番号） 人間が判読可能な電話番号（任意の電話番号形式）。 文字列
タイプ 電話番号のタイプ：
  • assistant
  • callback
  • car
  • company_main
  • custom
  • grand_central
  • home
  • home_fax
  • isdn
  • main
  • mobile
  • other
  • other_fax
  • pager
  • radio
  • telex
  • tty_ttd
  • work
  • work_fax
  • work_mobile
  • work_pager
 文字列
Custom Type（カスタムタイプ） 必須。タイプがカスタムの場合はユーザー定義値。 文字列
Primary?（プライマリー？） これがユーザーのプライマリー電話番号かどうかを示します。 ブール値
Websites (ウェブサイト)
Website URL（ウェブサイトURL） ウェブサイトのURL。 文字列
タイプ ウェブサイトのタイプまたは目的：
  • app_install_page
  • blog
  • custom
  • ftp
  • home
  • home_page
  • other
  • profile
  • reservations
  • resume
  • work
 文字列
Custom Type（カスタムタイプ） 必須。ウェブサイトタイプがカスタムの場合はユーザー定義値。 文字列
Primary?（プライマリー？） これがユーザーのプライマリーウェブサイトであるかどうかを示します。 ブール値
Records Streamed（ストリーミングされたレコード）

ストリーミングフロー内でストリーミングされたレコードの数。

［Result Set（結果セット）］オプションで［Stream Matching Records（一致レコードのストリーミング）］ が選択されている場合に表示されます。

 数値

関連項目

Google Workspace Adminコネクター

Workflows要素

Google Workspace APIのドキュメント