Skip to content

chore: add callout for granular read use case #5084

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

Merged
merged 3 commits into from
Mar 29, 2023
Merged

chore: add callout for granular read use case #5084

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00679ef
chore: add callout for granular read use case
AaronZyLee Feb 2, 2023
d604a2c
Update src/pages/cli/graphql/authorization-rules.mdx
AaronZyLee Feb 3, 2023
bb34ac5
Update src/pages/cli/graphql/authorization-rules.mdx
renebrandel Mar 28, 2023
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
6 changes: 6 additions & 0 deletions src/pages/cli/graphql/authorization-rules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,4 +480,10 @@ Authorization rules consists of:
- **authorized operations** (`operations`): which operations are allowed for the given strategy and provider. If not specified, `create`, `read`, `update`, and `delete` operations are allowed.
- **`read` operation**: `read` operation can be replaced with `get`, `list`, `sync`, `listen`, and `search` for a more granular query access

<Callout warning>

If you use DataStore instead of the API category to connect to your AppSync API, then you must allow `listen` and `sync` operations for your data model.

</Callout>

**API Keys** are best used for public APIs (or parts of your schema which you wish to be public) or prototyping, and you must specify the expiration time before deploying. **IAM** authorization uses [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) to make request with policies attached to Roles. OIDC tokens provided by **Amazon Cognito user pool** or **3rd party OpenID Connect** providers can also be used for authorization, and enabling this provides a simple access control requiring users to authenticate to be granted top level access to API actions.