Skip to content

updated to add access function role #909

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 5 commits into
base: release/3.3
Choose a base branch
from
Open

updated to add access function role #909

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5c48799
updated to add access function role
iamfortune Aug 12, 2025
984298f
remove automatically
iamfortune Aug 12, 2025
a83218e
updated to comply with style guide
iamfortune Aug 12, 2025
9233a5e
Merge branch 'release/3.3' into DOC-10950-sgw-functions-access-functi…
iamfortune Oct 2, 2025
ea8ae2c
update to show users might exist
iamfortune Oct 2, 2025
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
3 changes: 3 additions & 0 deletions modules/ROOT/pages/_partials/sync-api/sync-function-api-access.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ This grants access to the specified channel(s) for all users assigned that role.

The effects of all access calls by all active documents are effectively combined in a union, so if _any_ document grants a user access to a channel, that user has access to the channel.

The `access()` function grants access to users or roles that do not yet exist.
When you create such users or define roles later, the previous granted access permissions apply to them.

NOTE: The sync function `access()` call does not support the wildcard ('***') for granting access to all channels.
To grant a user access to all channels, use the REST API channel grant endpoint.

Expand Down