Auth Principal クレーム

authPrincipalクレームは、あらゆるDID Connectセッションの基盤です。これは最も基本的で一般的に使用されるクレームであり、ユーザーにウォレットを接続し、アプリケーションと対話するための分散型識別子（DID）を選択するよう求めるように設計されています。この最初のステップで安全なセッションが確立され、アプリケーションにユーザーのプライマリDIDが提供されます。その後のすべての対話は、このDIDに基づいて構築されます。

これは「ウォレットでログイン」ボタンのようなものだと考えてください。特定の個人データを要求するのではなく、単にユーザーがアカウントを選択して自身を識別することを要求します。

使用する場面

ユーザーとの対話が必要なほとんどすべてのワークフローの最初のステップとして、authPrincipalクレームを使用する必要があります。これには以下が含まれます：

パラメータ

authPrincipalクレームは、ニーズに合わせてリクエストを調整するために、以下のパラメータで設定できます。

Target Type フィールド

targetTypeオブジェクトには、ユーザーに提示されるDIDをフィルタリングするために、次のフィールドを含めることができます：

使用例

標準アカウントでの接続をユーザーに要求する方法は次のとおりです。これは通常、DID Connect設定のclaims配列内で行われます。

基本的な接続を要求する

const claims = {
  authPrincipal: {
    description: 'Sign in to our awesome app',
  },
};

// このclaimsオブジェクトは、WalletAuthenticatorインスタンスによって使用されます
// ユーザーがスキャンするためのQRコードを生成する際に。

例：特定のタイプのDIDを要求する

アプリケーションが特定のブロックチェーンと対話する必要がある場合や、特定のキータイプが必要な場合は、targetTypeを使用できます。

Ethereum互換のDIDを要求する

const claims = {
  authPrincipal: {
    description: 'Connect your Ethereum-compatible account',
    targetType: {
      key: 'ethereum',
      role: 'account',
    },
  },
};

ウォレットの応答

ユーザーがQRコードをスキャンし、ウォレットでリクエストを承認すると、アプリケーションのonConnectおよびonAuthハンドラーがトリガーされます。onAuthコールバックは、ユーザーが選択したDIDと公開鍵を含むセッションオブジェクトを受け取ります。

onAuthコールバックの例

const handlers = new WalletHandlers({
  // ...他のハンドラー
  onAuth: async (session) => {
    console.log('ユーザーが接続しました！', session);
    // sessionオブジェクトには以下が含まれます：
    // session.userDid - 例：'z1...'（ユーザーのアドレス）
    // session.userPk - ユーザーの公開鍵（base58形式）

    // これでデータベースにユーザーセッションを作成したり
    // ワークフローの次のステップに進むことができます。
  },
});

次のステップ

authPrincipalクレームでセッションが確立されると、ユーザーにさらに詳細な情報やアクションを要求することができます。一般的な次のステップには以下が含まれます：