メインコンテンツまでスキップ

組織メンバーの招待

マルチテナンシーアプリケーションでは、組織にメンバーを招待することが一般的な要件です。このガイドでは、その機能を実装するための手順と技術的な詳細を説明します。

フロー概要​

全体のプロセスは、以下の図で示されています：

組織ロールの作成​

メンバーを招待する前に、組織ロールを作成します。ロールと権限については 組織テンプレート を参照してください。

このガイドでは、典型的な組織ロールである admin と member を作成します。

admin ロールは組織内のすべてのリソースへのフルアクセス権を持ち、member ロールは限定的なアクセス権を持ちます。例えば：

  • admin ロール:
    • read:data - 組織のすべてのデータリソースの読み取り権限
    • write:data - 組織のすべてのデータリソースの書き込み権限
    • delete:data - 組織のすべてのデータリソースの削除権限
    • invite:member - 組織へのメンバー招待権限
    • manage:member - 組織内のメンバー管理権限
    • delete:member - 組織からのメンバー削除権限
  • member ロール:
    • read:data - 組織のすべてのデータリソースの読み取り権限
    • write:data - 組織のすべてのデータリソースの書き込み権限
    • invite:member - 組織へのメンバー招待権限

これは Logto コンソール で簡単に設定できます。また、Logto Management API を使ってプログラムから組織ロールを作成することも可能です。

メールコネクターの設定​

招待はメールで送信されるため、メールコネクター が正しく設定されていることを確認してください。招待メールを送信するには、使用タイプが OrganizationInvitation の メールテンプレート を設定します。組織（例：名前、ロゴ）や招待者（例：メールアドレス、名前）の 変数 を内容に含めることができ、必要に応じて ローカライズされたテンプレート もカスタマイズできます。

OrganizationInvitation 用のサンプルメールテンプレートは以下の通りです：

{
  "subject": "Welcome to my organization",
  "content": "<p>Join {{organization.name}} by this <a href=\"{{link}}\" target=\"_blank\">link</a>.</p>",
  "usageType": "OrganizationInvitation",
  "type": "text/html"
}

メール本文の {{link}} プレースホルダーは、メール送信時に実際の招待リンクに置き換えられます。

注記:

Logto Cloud の組み込み「Logto email service」では、現在 OrganizationInvitation 使用タイプはサポートされていません。独自のメールコネクター（例：SendGrid）を設定し、OrganizationInvitation テンプレートを用意してください。

Logto Management API で招待を処理する​

注記:

Logto Management API のセットアップがまだの場合は、Management API との連携 を参照してください。

Logto Management API で組織招待を作成する​

組織機能には招待関連の Management API が用意されています。これらの API で次のことができます：

  • POST /api/organization-invitations: 組織ロールを割り当てて組織招待を作成
  • POST /api/one-time-tokens: 招待を承諾する際に招待者が認証するためのワンタイムトークンを作成 詳細はこちら
  • POST /api/organization-invitations/{id}/message: 組織招待をメールで招待者に送信
注記:

ペイロードは link プロパティをサポートしているため、招待 ID をもとに独自の招待リンクを作成できます。例：

{
  "link": "https://your-app.com/invitation/join?id=your-invitation-id&token=your-one-time-token&email=invitee-email"
}