はじめに

このドキュメントでは、外部APIクライアントの作成、公開鍵の登録、アクセストークンの取得、および外部クライアント用APIを使ったルームロールと組織ロールの取得・変更について説明します。

外部APIクライアントはmetatell外部のシステムから、metatellのルームロールと組織ロールを変更するための仕組みです。

組織の管理者は管理画面から外部APIクライアントの作成および公開鍵の追加ができます。外部システムは対応する秘密鍵を使って外部クライアント用APIを呼び出すことでロールを変更します。

できること

• ユーザーのルームロールを取得・設定・解除
• グループのルームロールを取得・設定・解除
• ログインユーザーの既定ルームロールを取得・設定・解除
• 未ログインユーザーのルームロールを取得・設定・解除
• ユーザーの組織ロールを取得・変更

連携の流れ

クライアントごとに操作（read / write）、対象ルーム、対象グループ、設定可能なルームロールを制限できます。連携システムには必要最小限の権限だけを付与してください。

前提条件

• metatellの組織管理者であること

このガイドの構成

1. 外部APIクライアントの作成 — 鍵ペアの生成、管理画面での登録、権限設定、鍵のローテーション
2. 認証とアクセストークンの取得 — private_key_jwtの作成とOAuthトークンの取得
3. 外部クライアント向けAPIの仕様 — エンドポイント、リクエスト・レスポンス、エラー