Hikka DocsScopes
Available OAuth scopes
User
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:user-details | Read basic user profile information. |
| 🟨 UPDATE | update:user-details | Update user profile information. |
| 🟨 UPDATE | update:user-details:email | Update the user’s email address. |
| 🟨 UPDATE | update:user-details:password | Update the user’s account password. |
| 🟨 UPDATE | update:user-details:username | Change the user’s username. |
| 🟨 UPDATE | update:user-details:description | Update the user’s profile description/bio. |
| 🟧 DELETE | delete:user-details:image | Remove the user’s profile image. |
| 🟧 DELETE | delete:user-details:cover | Remove the user’s profile cover. |
| 🔓 FULL | user-details | Full access to user profile data. |
Lists
Watchlist
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:watchlist | Read the user’s watchlist. |
| 🟨 UPDATE | update:watchlist | Add, update, or remove watchlist items. |
| 🔓 FULL | watchlist | Full access to the watchlist. |
Readlist
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:readlist | Read the user’s readlist. |
| 🟨 UPDATE | update:readlist | Manage items in the readlist. |
| 🔓 FULL | readlist | Full access to the readlist. |
Export
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:export-list | Export user lists and related data. |
| 🔓 FULL | export | Full access to export functionality. |
OAuth Clients
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:client:list | Read the list of OAuth clients. |
| 🟦 READ | read:client | Read details of a specific OAuth client. |
| 🟩 CREATE | create:client | Create a new OAuth client. |
| 🟨 UPDATE | update:client | Update OAuth client configuration. |
| 🟨 UPDATE | verify:client | Verify or validate an OAuth client. |
| 🟧 DELETE | delete:client | Delete an OAuth client. |
| 🔓 FULL | client | Full access to OAuth clients. |
Collections
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:collection | Read collections. |
| 🟩 CREATE | create:collection | Create a new collection. |
| 🟨 UPDATE | update:collection | Update an existing collection. |
| 🟧 DELETE | delete:collection | Delete a collection. |
| 🔓 FULL | collection | Full access to collections. |
Articles
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:articles | Read articles. |
| 🟦 READ | read:articles_top | Read top or featured articles. |
| 🟩 CREATE | create:article | Create a new article. |
| 🟨 UPDATE | update:article | Update an existing article. |
| 🟧 DELETE | delete:article | Delete an article. |
| 🔓 FULL | article | Full access to articles. |
Edits
| Action | Scope | Description |
|---|---|---|
| 🟩 CREATE | create:edit | Create an edit proposal. |
| 🟨 UPDATE | update:edit | Update an edit proposal. |
| 🟨 UPDATE | close:edit | Close an edit proposal. |
| 🟨 UPDATE | accept:edit | Accept an edit proposal. |
| 🟨 UPDATE | deny:edit | Reject an edit proposal. |
| 🔓 FULL | edit | Full access to edit workflow. |
Social
Comments
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:comment:score | Read comment scores or ratings. |
| 🟩 CREATE | create:comment | Create a new comment. |
| 🟨 UPDATE | update:comment | Update an existing comment. |
| 🟧 DELETE | delete:comment | Delete a comment. |
| 🔓 FULL | comment | Full access to comments. |
Favourites
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:favourite | Read favourites. |
| 🟦 READ | read:favourite:list | Read the list of favourite items. |
| 🟩 CREATE | create:favourite | Add an item to favourites. |
| 🟧 DELETE | delete:favourite | Remove an item from favourites. |
| 🔓 FULL | favourite | Full access to favourites. |
Follow
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:follow | Read follow relationships. |
| 🟨 UPDATE | follow | Follow another user. |
| 🟨 UPDATE | unfollow | Unfollow a user. |
| 🔓 FULL | follow-full | Full access to follow/unfollow actions. |
History
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:history | Read user activity history. |
Notifications
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:notification | Read user notifications. |
| 🟨 UPDATE | seen:notification | Mark notifications as seen. |
| 🔓 FULL | notification | Full access to notifications. |
Votes
| Action | Scope | Description |
|---|---|---|
| 🟦 READ | read:vote | Read voting data. |
| 🟨 UPDATE | set:vote | Cast or update a vote. |
| 🔓 FULL | vote | Full access to voting. |
Uploads
| Action | Scope | Description |
|---|---|---|
| 🟩 CREATE | upload | Upload files or media. |
Global
| Action | Scope | Description |
|---|---|---|
| 🚨 FULL | all | Full access to all resources and actions. |