Skip to content

Commit 0f3870f

Browse files
AaronZyLeedavid-mcafeerenebrandel
authored
chore: add callout for granular read use case (aws-amplify#5084)
* chore: add callout for granular read use case * Update src/pages/cli/graphql/authorization-rules.mdx Co-authored-by: David McAfee <[email protected]> * Update src/pages/cli/graphql/authorization-rules.mdx --------- Co-authored-by: David McAfee <[email protected]> Co-authored-by: Rene Brandel <[email protected]>
1 parent c2f2ca2 commit 0f3870f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/pages/cli/graphql/authorization-rules.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,4 +503,10 @@ Authorization rules consists of:
503503
- **authorized operations** (`operations`): which operations are allowed for the given strategy and provider. If not specified, `create`, `read`, `update`, and `delete` operations are allowed.
504504
- **`read` operation**: `read` operation can be replaced with `get`, `list`, `sync`, `listen`, and `search` for a more granular query access
505505

506+
<Callout warning>
507+
508+
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.
509+
510+
</Callout>
511+
506512
**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.

0 commit comments

Comments
 (0)