Claudia Partner™DocsAPI・MCP 共通ドキュメント0.7.0-experimental

理解する

用語集

このガイドで使う用語の意味です。同じ概念には同じ呼び名を使い、APIの識別子や正式名称はそのまま記載します。HTTPの呼び出しは「リクエスト」、必要な条件は「要求する」、JWT assertionは「署名付きの要求」と区別します。

登場する人ともの

用語意味
利用者(human)基盤にログインして、アプリやAIエージェントを使う人。基盤は、操作のたびに、その時点の権限とMFAを確認する
あなた(開発者)このガイドを読み、アプリや処理を作る人
顧客アプリ顧客の業務に合わせて開発する、画面とサーバー側を持つアプリ。API上のapp(アプリ定義)とは別
顧客アプリのサーバー側(BFF)ブラウザーで使う顧客アプリが、トークンを預かるために持つ、サーバー側の部分
service人の操作なしに動く処理(バッチや連携)。管理者の承認を受けた、表・列・操作・期限の範囲だけで動く
AIエージェント利用者を助けて、操作を行うもの。利用者の権限を超えられない
基盤Claudia Partner 基盤。ログイン、権限、データ、メディア、アプリ定義を扱う共通サービス
APIプログラムがサービスを呼び出す入口の総称。基盤API、認証サービスのAPI、管理サイトの取込APIは、接続先と資格が異なる
基盤APIClaudia Partnerのデータと認可を扱うAPI。パスは/v1と/v2の系列
認証サービス(IdP)利用者のログインを担うサービス。OIDC(OpenID Connect)を使う
組織の管理者あなたの組織で、利用者の権限を設定し、アプリ定義を登録し、serviceを承認する人。管理権限(manage_accessとservice_administratorの両方)と、MFAが必要。権限の付与は、環境管理者に依頼する
環境管理者利用環境の接続情報、有効機能、設定を管理する技術上の役割。担当する組織や人は、利用環境の取り決めによる
manage_accessアクセスの管理の権限(追加の管理面で判定する)。表を閲覧できる権利とは、別
service_administratorserviceの管理で、必須の、登録された管理者の条件
利用環境基盤の接続先の単位。URL、有効な機能、稼働版、利用者が利用環境ごとに異なる。OSの開発環境や環境変数とは別
管理サイトClaudia Partnerの管理サイト。「連携」の「MCP接続管理」で、MCPの接続キーの発行・取り消しと、MCPクライアントのダウンロードができる

ログインと資格

用語意味
OIDCログインの標準の方式(OpenID Connect)。認証サービスが、利用者を確認する
PKCE認可コードを盗まれても使えないようにする仕組み。ログインのリクエストごとに、使い捨ての値を使う
SSOSingle Sign-On。認証サービスのログイン状態を使い、連携するアプリのログインをまとめる仕組み。使えるアプリと追加MFAの条件は利用環境の設定による
MFA多要素認証。パスワードに加えて、もう1つの確認を行う
アクセストークン基盤APIの呼び出しに付ける、有効期限のある資格
リフレッシュトークンアクセストークンを更新するための資格
issuer認証サービスのURL(識別子)
client_id認証サービスに登録した、アプリを識別するID。環境管理者から受け取る
redirect_uriログインの後に、認証サービスが利用者を戻すURL。登録済みのものだけが使える
scopeトークンに求める、権限の種類
接続キーMCPアダプターが管理サイトに接続するための、管理サイト用の資格。キー所有者の許可範囲で使う。人OIDCのトークンや基盤APIのservice JWTとは別
provision / activateserviceを使えるようにする手順。provisionで接続の情報を用意し、activateで有効にする

データ

用語意味
ケース / casev2の/v2/casesで扱う単位。アプリが用途に合わせて使う。v1の/v1/jobs(ジョブ)とは別の契約
表 / collectionデータを入れる表。collectionは、その識別子で、画面のラベルとは別
definition表の定義(列と型)。schema_versionは、その版
version行や資格など、取得した対象そのものの版。更新の競合を検出するのに使う
revisionアプリや表の状態の変更の版(整数)。v2の検索や変更の監視が返すrevisionは、見えている行の集合の変更を表す、不透明な文字列で、数値として扱わない(大小の比較や、増分の計算をしない)
plan / fingerprint適用の前に作る、変更の差分と確認の対象。適用のときに、同じ計画かを照合する
アプリ定義 / app表、依存先、版を登録した、API上の単位。顧客アプリの実行プログラムや配置先とは別
draft / committed表の保存の状態。ケースの業務の進み具合とは別
外部ストアDropboxなど、基盤とは別の原本の保存先。基盤が参照するには、利用環境での接続設定と対象への権限が必要
custody画像の原本の保管の方式。managed_original(基盤が管理)とexternal_reference(外部の原本への参照)
policy / store画像の許可条件(policy)と、参照できる保存先の名前(store)。policyは、APIで取得する

通信と再送

用語意味
リクエストクライアントがHTTPなどで送る呼び出し。仕様ファイルの「要求・応答」はリクエスト・応答を意味する
Idempotency-Key同じ操作の再送を見分けるキー。二重に実行されないようにする
If-Match操作が要求する、期待する版を指定するヘッダー
request_idリクエストごとの識別子。問い合わせに添える
結果不明(OUTCOME_UNKNOWN)操作が完了したか、確認できない状態。失敗とは限らない

AIエージェント

用語意味
MCPAIエージェントが、ツールを呼び出すための、共通の接続方式
MCPホストMCPのツールを呼び出す、AIエージェントのアプリケーション
MCPアダプター手元のPCで動き、AIエージェントのMCPを、管理サイトへの接続に変換するプログラム