Search Users（ユーザーの検索）
1人以上ユーザーを検索します。
オプション
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
| Return |
[Single user (単一のユーザー)]か[All matching users (一致するすべてのユーザー)]を選択します。
Single user (単一のユーザー): こちらを選択した場合、このカードは検索条件に最初に一致したユーザーを返します。特定のユーザーを探している場合にこのオプションを使用します。 All matching users (一致するすべてのユーザー): こちらを選択した場合、このカードは検索条件に一致するユーザーの集合を返します。フィルタリングされたユーザーのセットを探している場合にこのオプションを使用します。 |
ドロップダウン | TRUE |
入力
| フィールド | 定義 | タイプ | 必須 |
|---|---|---|---|
| ユーザー | |||
| 名前 | ユーザーの名前。 | 文字列 | FALSE |
| External ID（外部ID） |
ユーザーの一意の外部ID。 |
文字列 | FALSE |
| メール | ユーザーのプライマリーメールアドレス。 | 文字列 | FALSE |
| 電話 | ユーザーのメインの電話番号。 | 文字列 | FALSE |
| グループ | ユーザーが関連付けられているグループの名前。 | 文字列 | FALSE |
| Details（詳細） |
ユーザーに関する他の詳細情報。
たとえば、住所など。 |
文字列 | FALSE |
| 備考 | ユーザーのメモ。 | 文字列 | FALSE |
| Organization | ユーザーが関連付けられているOrganizationの名前。 | 文字列 | FALSE |
| ロール | ユーザーのロール。使用可能な値は［end-user（エンドユーザー）］、［agent （エージェント）］、［admin（管理者）］。 |
文字列 | FALSE |
| タグ | ユーザーのタグ。アカウントでユーザーのタグ付けが利用できる場合のみ表示されます。 | リスト | FALSE |
| カスタムフィールド | ユーザーに関連付けられているカスタムフィールドの動的に生成されたリスト。カスタムフィールドの詳細。 | 各種 | FALSE |
出力
| フィールド | 定義 | タイプ |
|---|---|---|
| ユーザー | ||
| ユーザーID | ユーザーの一意識別子。 | 文字列 |
| User URL（ユーザーのURL） | ユーザーのURL。 | 文字列 |
| 名前 | ユーザーの名前。 | 文字列 |
| メール | ユーザーのプライマリーメールアドレス。 | 文字列 |
| 作成日時 |
オブジェクトが作成された日時。 |
日時 |
| 更新日時 | ユーザーの更新日時。 | 日時 |
| タイムゾーン | ユーザーのタイムゾーン。「タイムゾーン」を参照してください。 | 文字列 |
| IANA Timezone（IANAタイムゾーン） | ユーザーのIANAタイムゾーン。 | 文字列 |
| 電話 | ユーザーの電話番号。 | 文字列 |
| Shared Phone Number (共有電話番号) | [true]の場合、電話番号は共有済み。 |
ブール値 |
| Locale ID（ロケールID） | ユーザーの言語識別子。 | 数値 |
| ロケール | ユーザーのロケール（BCP-47準拠のタグ）。 | 文字列 |
| Organization ID | ユーザーが関連付けられているOrganizationの識別コード。 | 数値 |
| ロール | ユーザーのロール。使用可能な値は［end-user（エンドユーザー）］、［agent （エージェント）］、［admin（管理者）］。 |
文字列 |
| Verified?（検証済み？） | ユーザーのIDは検証されています。[true]の場合、ユーザーは検証済み。 |
ブール値 |
| External ID（外部ID） |
ユーザーの一意の外部ID。 |
文字列 |
| タグ | ユーザーのタグ。アカウントでユーザーのタグ付けが利用できる場合のみ表示されます。 | 文字列 |
| Alias（エイリアス） | エンドユーザーに表示されるエイリアス。 | 文字列 |
| アクティブ？ | ［false］の場合、ユーザーは削除済み。 |
ブール値 |
| Shared?（共有？） | ユーザーが別のZendeskサポートインスタンスから共有されているかどうか。［true］の場合、ユーザーは共有済み。 |
ブール値 |
| Shared Agent? (共有エージェント？) | [true]の場合、ユーザーは別のサポートインスタントからの共有エージェント。 |
ブール値 |
| Last Login At（最終ログイン時刻） | ユーザーの最終サインイン時刻。 | 日時 |
| Two Factor Auth Enabled（2要素認証が有効） | [true]の場合、2要素認証が有効。 |
ブール値 |
| Signature（署名） | ユーザーの署名（署名があるのはエージェントと管理者のみ）。 | 文字列 |
| Details（詳細） | ユーザーに関する、たとえば住所など他の詳細情報。 | 文字列 |
| 備考 | ユーザーのメモ。 | 文字列 |
| Role Type（ロールタイプ） | ユーザーのロールタイプ。 | 数値 |
| Custom Role ID（カスタムロールID） | ユーザーのカスタムロール。 | 数値 |
| Moderator? (モデレーター？) | ［true］の場合、ユーザーにフォーラムのモデレーション機能あり。 |
ブール値 |
| Ticket Restriction（チケット制限） | ユーザーがアクセスできるチケットを指定します。 | 文字列 |
| Private Comments Only?（プライベートコメントのみ？） | [true]の場合、ユーザーが作成できるのはプライベートコメントのみ。 |
ブール値 |
| Restricted Agent?（制限付きエージェント？） | ［true］の場合、エージェントに制限あり。 |
ブール値 |
| Suspended? (保留？) | ［true］の場合、エージェントは保留中。 |
ブール値 |
| Chat Only? (チャットのみ？) | ［true］の場合、ユーザーはチャットのみのエージェント。 |
ブール値 |
| Default Group ID（デフォルトグループのID） | ユーザーのデフォルトグループのID。 | 数値 |
| Report CSV? (CSVレポートにアクセス？) | ［true］の場合、ユーザーはCSVレポートにアクセス可能。 |
ブール値 |
| カスタムフィールド | ユーザーに関連付けられているカスタムフィールドの動的に生成されたリスト。「カスタムフィールドタイプについて」を参照してください。 | 各種 |