Skip to content

feat(hub-common): update docs to reexpose write permisson channelAcl #1863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(hub-common): update docs to reexpose write permisson channelAcl #1863

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/guides/functional/discussions-v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ Each entry in `channel.channelAcl` has the following shape:
| category | [AclCategory](https://esri.github.io/hub.js/api/common/AclCategory/) | Category for the permission (`group`, `org`, `anonymousUser`, `authenticatedUser`) <br> Category: `user` not API supported |
| subCategory | [AclSubCategory](https://esri.github.io/hub.js/api/common/AclSubCategory/) | SubCategory for the permission (`admin`, `member`) <br> Only valid for category: `group` or `org` |
| key | string | Identifier for the category <br> Only valid for category: `group` or `org` or `user` <br> For category: `group` - key is the `ArcGIS Online Group ID` <br> For category: `org` - key is the `ArcGIS Online Organization ID` <br> For category: `user` - key is the user's `ArcGIS Online username` (not API supported) |
| role | [Role](https://esri.github.io/hub.js/api/common/Role/) | Role for the permission (`manage`, `readWrite`, `read`) <br> Role: `owner`, `moderate`, `write` not API supported |
| role | [Role](https://esri.github.io/hub.js/api/common/Role/) | Role for the permission (`manage`, `readWrite`, `read`, `write`) <br> Role: `owner`, `moderate`, not API supported |


## Channel participation configuration examples
Expand Down Expand Up @@ -439,7 +439,7 @@ A summary of authorization checks are in the table below (source code: [channels
| :------------- | :-------------- |
| create a channel | - create acl entry with category: `anonymousUser OR authenticatedUser` - user has portal privilege `portal:admin:shareToPublic` or `portal:user:shareToPublic` <br> - create acl entry with category: `group`, subCategory: `admin` - user is the group owner or admin <br> - create acl entry with category: `group`, subCategory: `member` - user is a group member <br> - create acl entry with category: `org`, subCategory: `admin or member` - user has portal privilege `portal:admin:shareToOrg` or `portal:user:shareToOrg` |
| view posts in channel | - an acl entry has category: `anonymousUser` with role: `read` <br> - OR acl entry has category: `authenticatedUser` with role: `read OR readWrite` <br> - OR acl entry has category: `group`, subCategory: `admin OR member` with role `read or readWrite or manage`, and the user is in the group, as a member or admin <br> - OR acl entry has category: `org`, subCategory: `admin OR member` with role `read or readWrite or manage`, and the user is in the org, as a member or admin |
| create post in channel | - acl entry has category: `authenticatedUser` with role: `readWrite` <br> - OR acl entry has category: `group`, subCategory: `admin OR member` with role `readWrite or manage`, and the user is in the group, as a member or admin <br> - OR acl entry has category: `org`, subCategory: `admin OR member` with role `readWrite or manage`, and the user is in the org, as a member or admin |
| create post in channel | - acl entry has category: `authenticatedUser` with role: `readWrite OR write` <br> - OR acl entry has category: `group`, subCategory: `admin OR member` with role `readWrite OR write OR manage`, and the user is in the group, as a member or admin <br> - OR acl entry has category: `org`, subCategory: `admin OR member` with role `readWrite, write, or manage`, and the user is in the org, as a member or admin |
| moderate post in channel | - acl entry has category: `group`, subCategory: `admin OR member` with role `manage`, and the user is in the group, as a member or admin <br> - OR acl entry has category: `org`, subCategory: `admin OR member` with role `manage`, and the user is in the org, as a member or admin |

# In Conclusion
Expand Down