権限
リクエストで実行できる操作は、APIキーまたはアプリ連携のスコープと、ワークスペースおよびプロジェクトでのあなたのロールの2つで決まります。
スコープ
各エンドポイントのリファレンスページに、必要なスコープが記載されています。 キーや連携は、そのスコープで許可されたエンドポイントのみ呼び出せます。スコープがない場合は、Pingのみ呼び出せます。
| スコープ | 許可される操作 |
|---|---|
projects:read | プロジェクトの検索と取得 |
projects:write | プロジェクトの作成と更新、削除の予約とキャンセル |
folders:read | フォルダーの一覧取得と個別取得 |
folders:write | フォルダーの作成、更新、削除 |
files:read | ファイルの一覧取得と個別取得 |
files:write | ファイルのアップロード、更新、タグ付け、削除 |
files:download | ファイルのダウンロードURLの取得 |
ai:generate | AIモデルの一覧取得、AIによるファイル生成、AI生成添付ファイルのアップロード |
comments:read | コメント、返信、リアクションの一覧取得と個別取得 |
comments:write | コメント、リアクション、コメント添付ファイルの作成、更新、削除 |
comments:download | コメント添付ファイルのダウンロードURLの取得 |
workspace-members:read | ワークスペースメンバーの一覧取得 |
project-members:read | プロジェクトメンバーの一覧取得 |
project-members:write | プロジェクトメンバーの追加、更新、削除 |
access-links:read | アクセスリンクの一覧取得と個別取得 |
access-links:write | アクセスリンクの作成、更新、削除 |
access-links:read.key | アクセスリンクの accessKey の参照。このスコープがない場合、accessKey は null |
skills:read | スキルとスキルバージョンの一覧取得と個別取得 |
skills:write | スキルの作成、更新、削除、スキルバージョンの公開と削除 |
ロール
リクエストはあなたとして動作するため、アプリで開けるプロジェクトと同じプロジェクトにアクセスできます。
- 参加しているプロジェクト
- ワークスペース全体に公開されているプロジェクト
- ワークスペースの所有者または管理者の場合、ワークスペース内のすべてのプロジェクト
- 他のワークスペースからあなたのワークスペースに連携されたプロジェクト
プロジェクトロールが必要なエンドポイントは、許可されるロールをリファレンスページに記載しています。
一部の操作は、その項目を作成した人のみが行えます。
- コメントの編集と削除: コメントの作成者
- ファイルアップロードの完了: アップロードを開始した人
- コメント添付ファイルの完了、キャンセル、削除: アップロードした人
制限付きファイル
制限付きレビュアーには、共有されたファイル(allowRestricted が true)のみ表示されます。 プロジェクトに参加せず、ワークスペースロールでプロジェクトを開く場合も同様です。
プランの機能
AIファイル生成とスキルは、それらを含むプランでのみ利用できます。
アーカイブ済みプロジェクト
アーカイブ済みプロジェクトは読み取り専用です。 ダウンロードURLの取得、プロジェクトメンバーの削除、アクセスリンクの削除は引き続き行えます。