認証
APIキー
すべてのリクエストには Authorization ヘッダーでAPIキーを含める必要があります。
http
Authorization: Bearer YOUR_API_KEYヘッダーがない、またはキーが無効な場合、APIは 401 Unauthorized を返します。
ワークスペーススコープ
各APIキーは作成時に1つのワークスペースへ紐づきます。そのキーで行うリクエストは、そのワークスペース内でのみ動作します。アカウントが他のワークスペースのメンバーであっても、キーは他のワークスペースへアクセスできません。
アクセスルール
アクセスできる内容は、ワークスペース内のロールと各プロジェクトの参加状態によって決まります。
- ワークスペースメンバー（Owner、Manager、Member）は、ワークスペース全体に公開されたプロジェクトにアクセスできます。
- プロジェクトメンバー は、自分が参加しているプロジェクトにアクセスできます。
- 接続プロジェクトの参加者 は、他ワークスペースから共有されたプロジェクトにアクセスできます。
一部のエンドポイントでデータを書き込むには、最低限のプロジェクトロールが必要です。
| エンドポイント | 最小ロール |
|---|---|
| コメント作成 | Owner, Manager, Member, Reviewer, or RestrictedReviewer |
| タグ更新 | Owner, Manager, Member, Reviewer, or RestrictedReviewer |
| リアクション作成 | Owner, Manager, Member, Reviewer, or RestrictedReviewer |
| リアクション削除 | Owner, Manager, Member, Reviewer, or RestrictedReviewer |
リソースへの読み取り権限はあるが書き込み権限がない場合、APIは 403 Forbidden を返します。
制限付きレビュアー
制限付きレビュアーには、制限付きアクセスが明示的に許可されたファイルのみ返されます。同じプロジェクト内の他のファイルは返されません。