Skip to content
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.

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

[amplify-data] feat: add gen1 manyToMany auth discussion #8172

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -860,6 +860,58 @@ Refer to the [sample code](/gen1/[platform]/build-a-backend/graphqlapi/connect-f

</InlineFilter>

### Authorizing `@manyToMany` relationships

Under the hood, the [`@manyToMany` directive](/gen1/[platform]/build-a-backend/graphqlapi/data-modeling/#many-to-many-relationship) will create a "join table" named after the `relationName` to facilitate the many-to-many relationship. The authorization rules that Amplify applies to the "join table" it creates are a union of the authorization rules of the individual models in the many-to-many relationship.

For example, consider a schema in which the owner of a `Post` (protected by an `owner` rule) can apply `Tag`s that are created by a system admin (protected by a `groups` rule). Behind the scenes, Amplify creates a `PostTags` table with both `owner` and `groups` auth:

```graphql
type Post
@model
@auth(
rules: [
{ allow: owner }
]
) {
id: ID!
title: String!
content: String
tags: [Tag] @manyToMany(relationName: "PostTags")
}

type Tag
@model
@auth(
rules: [
{ allow: groups, groups: ["admins"] }
]
) {
id: ID!
label: String!
posts: [Post] @manyToMany(relationName: "PostTags")
}

### CREATED BEHIND THE SCENES
type PostTags
@model
@auth(
rules: [
{ allow: owner }
{ allow: groups, groups: ["admins"] }
]
) {
id: ID!
postId: ID!
tagId: ID!
post: Post!
tag: Tag!
owner: String
}
```

For more control over the join table's authorization rules, you can create the join table explicitly, linking it to each model with a `@hasMany`/`@belongsTo` relationship, and set appropriate auth rules for your application.

### How it works

Definition of the `@auth` directive:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -793,6 +793,12 @@ const posts = listPostsResult.data.listPosts;
const postTags = posts[0].tags; // access tags from post
```

<Callout>

**Important**: The authorization rules that Amplify applies to the "join table" it creates are a union of the authorization rules of the individual models in the many-to-many relationship. See [this discussion](/gen1/[platform]/build-a-backend/graphqlapi/customize-authorization-rules/#authorizing-manytomany-relationships) for more context.

</Callout>

## Assign default values for fields

You can use the `@default` directive to specify a default value for optional [scalar type fields](https://docs.aws.amazon.com/appsync/latest/devguide/scalars.html) such as `Int`, `String`, and more.
Expand Down
Loading