- PAT v2のスコープは
PERMISSION:RESOURCE
の形式で定義されています
-
PERMISSION
はHTTPメソッドに対応しています。
-
RESOURCE
は操作対象のリソース名(単数形)に対応しています。
PERMISSION |
HTTPメソッド |
説明 |
read |
GET |
データの参照 |
write |
POST , PUT , PATCH
|
データの作成・更新 |
delete |
DELETE |
データの削除 |
admin
権限は read
, write
, delete
のすべてが許可されます。
例えば admin:post
は read:post write:post delete:post
と同等の意味になります。
RESOURCE |
説明 |
attachment |
記事やコメント上でアップロードされた添付ファイルです。 |
category |
記事のカテゴリーです。 |
comment |
記事に対するコメントです。 |
emoji |
チームにアップロードしたカスタム絵文字や絵文字のエイリアスです。 |
invitation |
チームへのメンバー招待です。 |
member |
チームとユーザーアカウントを紐づけるメンバー情報です。メンバーの権限にはowner または member があります。 |
post |
チームに投稿した記事です。 |
revision |
記事の更新情報です。記事を更新するたびに、revisionが1つ作成されます。 |
sharing |
記事の外部公開情報です。 |
star |
記事やコメントに対するStar(スター)の情報です。 |
tag |
記事のタグです。 |
team |
チーム自体の情報です。 |
user |
ユーザーアカウント自体の情報です。 |
watch |
記事に対するWatch(ウォッチ)の情報です。 |
# スコープの定義
- PAT v2のスコープは `PERMISSION:RESOURCE` の形式で定義されています
- `PERMISSION` はHTTPメソッドに対応しています。
- `RESOURCE` は操作対象のリソース名(単数形)に対応しています。
## PERMISSION
| `PERMISSION` | HTTPメソッド | 説明 |
| --- | --- | --- |
| read | `GET` | データの参照 |
| write | `POST`, `PUT`, `PATCH` | データの作成・更新 |
| delete | `DELETE` | データの削除 |
### `admin` PERMISSION
`admin` 権限は `read`, `write`, `delete`のすべてが許可されます。
例えば `admin:post` は `read:post write:post delete:post` と同等の意味になります。
## RESOURCE
| RESOURCE | 説明 |
| --- | --- |
| attachment | 記事やコメント上でアップロードされた添付ファイルです。 |
| category | 記事のカテゴリーです。 |
| comment | 記事に対するコメントです。 |
| emoji | チームにアップロードしたカスタム絵文字や絵文字のエイリアスです。 |
| invitation | チームへのメンバー招待です。 |
| member | チームとユーザーアカウントを紐づけるメンバー情報です。メンバーの権限には`owner`または `member`があります。 |
| post | チームに投稿した記事です。 |
| revision | 記事の更新情報です。記事を更新するたびに、revisionが1つ作成されます。 |
| sharing | 記事の外部公開情報です。 |
| star | 記事やコメントに対するStar(スター)の情報です。 |
| tag | 記事のタグです。 |
| team | チーム自体の情報です。 |
| user | ユーザーアカウント自体の情報です。 |
| watch | 記事に対するWatch(ウォッチ)の情報です。 |
- PAT v2のスコープは
PERMISSION:RESOURCE
の形式で定義されています
PERMISSION
はHTTPメソッドに対応しています。
RESOURCE
は操作対象のリソース名(単数形)に対応しています。
PERMISSION |
HTTPメソッド |
説明 |
read |
GET |
データの参照 |
write |
POST , PUT , PATCH |
データの作成・更新 |
delete |
DELETE |
データの削除 |
admin
権限は read
, write
, delete
のすべてが許可されます。
例えば admin:post
は read:post write:post delete:post
と同等の意味になります。
RESOURCE |
説明 |
attachment |
記事やコメント上でアップロードされた添付ファイルです。 |
category |
記事のカテゴリーです。 |
comment |
記事に対するコメントです。 |
emoji |
チームにアップロードしたカスタム絵文字や絵文字のエイリアスです。 |
invitation |
チームへのメンバー招待です。 |
member |
チームとユーザーアカウントを紐づけるメンバー情報です。メンバーの権限にはowner または member があります。 |
post |
チームに投稿した記事です。 |
revision |
記事の更新情報です。記事を更新するたびに、revisionが1つ作成されます。 |
sharing |
記事の外部公開情報です。 |
star |
記事やコメントに対するStar(スター)の情報です。 |
tag |
記事のタグです。 |
team |
チーム自体の情報です。 |
user |
ユーザーアカウント自体の情報です。 |
watch |
記事に対するWatch(ウォッチ)の情報です。 |