メインコンテンツへスキップ
GET
curl

概要

認証済みアプリケーションのユーザーエンティティをページネーションされた一覧で返します。ユーザーをデータウェアハウスに同期する、アナリストの対応が必要なユーザーを見つける、表示名で検索する、といった用途に使用します。

使用する場面

  • 外部のBIツールやデータウェアハウスへのユーザーテーブルの定期同期。
  • アナリスト用キュー: status=FLAGGEDや古いlast_activity_atの値でフィルターし、レビュー用の受信トレイに振り分けます。
  • display_name、full_name、vendor_dataによるユーザーの検索。

フィルターとページネーション

注意事項

  • 各レスポンス項目にはdidit_internal_idが含まれます。元のセッションまたは取引で指定されなかった場合、vendor_dataはnullになることがあります。
  • このエンドポイントではカーソルベースのページネーションを使用します。呼び出し間でnextカーソルを保持し、nextが空になったら停止してください。
  • ユーザーレコードのすべてのフィールドについては、ユーザーデータモデルを参照してください。

権限

アプリケーションの有効なAPIキーであれば、どれでもこのエンドポイントを呼び出せます。DiditのAPIキーは 役割単位ではなく、アプリケーション単位です。Consoleの役割と権限 (list:usersなど)は、Consoleで人が何をできるかを決めるものであり、Management APIのトラフィックに対しては 評価されません。このエンドポイントを呼び出せる人を制御するには、アプリケーションのAPIキーを 読み取れる人を制御してください。

関連項目

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

クエリパラメータ

limit
integer
デフォルト:50

ページサイズ。省略時は50です。強制される上限はありませんが、レイテンシーを抑えるためにページは小さく保ってください。

必須範囲: 1 <= x <= 1000000
offset
integer
デフォルト:0

返す最初のレコードの0始まりのオフセットです。手動で計算するよりも、前のページのnextURLをたどる方法を推奨します。

必須範囲: 0 <= x <= 1000000

レスポンス

認証ステータス、セッション数、機能別の内訳を含む、ページネーションされたユーザー一覧。

count
integer

一致する行の数。100までは正確な値で、パフォーマンスのため100を超える場合は100が上限となります。最終ページの判定には使用せず、代わりにnextがnullであることを利用してください。

next
string | null

次のページの絶対URL。最後のページではnullになります。

previous
string | null

前のページの絶対URL。最初のページではnullになります。

results
object[]
最終更新日 2026年11月1日