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

接続する

接続情報を依頼する

基盤に接続するための情報は、利用環境ごとに違います。確認済みの接続情報を、環境管理者から受け取ります。このページでは、何を受け取るのか、どう依頼するのかを説明します。

受け取る情報

項目内容何のための情報か
基盤HTTPS origin、API版、有効な機能基盤APIを呼ぶ接続先
認証サービスissuer(認証サービスのURL)、audience(トークンの宛先)、認証方式、必要なMFA利用者のログインと、トークンの取得
利用者用のクライアント登録済みのclient_id(アプリのID)、redirect_uri(ログイン後に戻るURL)、scope(求める権限の種類)利用者としての接続
利用者ログインの方法、利用する組織、必要な表の権限利用者としての接続
管理者の権限アプリ定義の登録、利用者の権限の設定、serviceの承認を行う利用者への、管理権限(manage_accessとservice_administratorの両方)の付与管理の操作
検証用の表collection(表の識別子)、現在のschema_version、許可する操作、検証用の行最初の読み書き
管理サイト(MCPの取込を使う場合)管理サイトのHTTPS origin、利用者のアカウント。利用環境ごとに確認しますMCPアダプターの接続先
画像(使う場合)参照できる保存先(store)の名前と、Dropboxのどのフォルダーに対応するか。Dropboxの接続画像の参照の登録
証明書公開の認証局、または環境管理者が渡した検証用の証明書TLSの検証

基盤、顧客アプリ、認証サービスは、それぞれ別のURLです。このサイトでは仕様を配信します。APIの接続先は、利用環境の接続情報で確認します。

接続条件を確認する

利用環境で定められた連絡方法に従い、上の情報と、必要な表・操作・検証用データを確認してください。個別アプリ用の人OIDCクライアント登録・BFF接続は準備中、自己登録UI/APIは未提供です。この手順は、登録済みclient_idとredirect_uriを受け取れる利用環境が前提です。

アプリのOSと配置先は、開発者が利用条件に合わせて選びます。loopbackのredirect_uriの利用可否は利用環境によります。利用環境間で配置を変える場合は、登録済みredirect_uri、issuer、audience、HTTPS到達性、信頼するCA、資格の保管方法を再確認します。特定OSや移行先を共通要件にはしません。

文書の誤記・一般的な接続条件の質問は、公開Issuesへ。実際の接続先、顧客の名前・データ、資格は投稿せず、必要なら利用環境で定められた非公開の連絡方法を使います。

受け取った後に確認すること

次は、利用者として接続する、またはserviceとして接続するへ進みます。