authenticationスコープを持つ名前付きのAPIキーを使用してください。
以下のすべての呼び出しは、アプリケーションのAuthentication管理APIに送信されます。MANAGEMENT_BASEは次のとおりです:
openapi-authentication.jsonのSetupタグに記載されています。サーバーSDKはこのファイルから再生成されます。
どの認証情報を使うか
次の3種類の認証情報のいずれも使用できます。それぞれ、所有者が承認した範囲に限られます。
次の認証情報は、リクエストの内容にかかわらず、すべてのセットアップ用ルートで
403 により拒否されます:
- アプリケーションのプライマリシークレット。
POST /programmatic/loginから発行されたトークン。これはコンソールではなく、アプリケーション向けに発行されます。authenticationスコープを持たないキー。すべてのリソースを最上位レベルに設定して作成したキーも含まれます。これらは「フルアクセス」と表示され、scopesは空のままで、これらのルートでは受け付けられません。- 別のアプリケーションのキー、
didit:verificationのみに限定された付与、または別の組織向けに承認された付与。
401 を返します。付与やキーには、それ自体の制限がさらに適用されます。付与の場合はスコープ、組織、本人の役割が、キーの場合はスコープ、IP許可リスト、有効期限が適用されます。
アクセスの承認
名前付きAPIキーを使う
Business Consoleで Developers -> API keys を開き、設定するアプリケーション用のキーを作成します。authentication リソースには 読み取り または 書き込み を付与してください。読み取りは設定を読み取るすべての呼び出し(GET)に使えます。書き込みは設定を変更するすべての呼び出し(POST、PUT、PATCH、DELETE)に使え、設定の読み取りにも使えます。有効期限、IP許可リスト、ローテーションについてはAPIキーを参照してください。キーは1つのアプリケーションに属し、そのアプリケーションに対してのみ機能します。
MCP接続経由
Didit MCPサーバーに接続したエージェントは、所有者が同意画面で承認したグラントを使い、didit:management でアクセスします。詳しくはMCP認証を参照してください。
パスワードを持たない所有者向け
デバイスコードグラント(RFC 8628)を使うと、Google、パスキー、またはメールで届くコードでサインインする所有者は、パスワードを入力せずに、どのブラウザからでも同じアクセスを承認できます。詳しくはブラウザを使わないサインインを参照してください。メールコードを有効にする
PUT methods/{name}/ では、認証情報を必要としないメソッドの場合に限り enabled のみを指定します。
credential_source: null が含まれます。常に有効なメソッドは無効にできません。そのリクエストへのレスポンスは {"enabled": "always_on"} です。
Google を有効にする
ソーシャル認証方式では、ご自身の OAuth アプリの認証情報を使用します。サンドボックスアプリケーションの場合は、Didit のテストアプリの認証情報も使用できます。独自のGoogleアプリを使う
callback_uri を、プロバイダーに登録してください。シークレットは書き込み専用で、どのレスポンスにも返されません。読み取れるのは client_id のみです。以前に認証情報が保存されていない状態で、認証情報なしに方式を有効にすると、{"credentials": "required"} が返されます。
Didit のテストアプリ(didit_test)を使う
サンドボックスアプリケーションでは、ご自身のソーシャルアプリの代わりに Didit 独自のソーシャルアプリを使用できます。セットアップを完了して動作を確認するには、これで十分です。
didit_test は、サンドボックスアプリケーションに限り Google、Microsoft、Apple、GitHub に対応しています。
設定に対する
GET は、このアプリケーションでテストアプリが提供できるプロバイダーを didit_test_credentials に示します。本番環境のアプリケーションでは、4つのプロバイダーすべてで false になります。
設定を読み取る
GET を MANAGEMENT_BASE に対して呼び出すと、設定を読み取れます。各方式の enabled と credential_source、コールバックURL、セッションのルール、サインアップポリシーが返されます。
GET で有効な方式と無効な方式の両方を確認できます。認証がアプリケーションで無効になっている場合、先頭の enabled は false になります。その場合、管理用の権限または名前付きのAPIキーを使ったどの設定変更も {"detail": "product_disabled"} を伴う 409 を返し、何も書き込まれません。設定のAPI呼び出しだけで認証が有効になることはありません。認証を有効にするのは担当者がコンソールでアプリケーションに対して行い、それ以降はAPI呼び出しが機能します。
残りのセットアップ
グラントまたはキーでは、セットアップとそのカウンターは扱えますが、エンドユーザーのデータは扱えません。
users/、sessions/、sign-ins/、overview/、顧客組織、ロール、インポート、エージェントセッション、テストメールには、引き続きコンソールセッションが必要です。
agent_humans_only 設定は、アプリケーション全体に適用されます。変更できるのは組織のオーナーまたは管理者のみです。名前付きキーで変更しようとすると 403 owner_or_admin_required が返されます。この設定を有効にするには、登録済みのパスキーも必要です(passkey_required)。