diff --git a/docs/content/concepts.mdx b/docs/content/concepts.mdx index 85212a42d..567905ef7 100644 --- a/docs/content/concepts.mdx +++ b/docs/content/concepts.mdx @@ -207,7 +207,7 @@ A **user** is an entity in the system that can be related to an object. -A user is is a combination of a [type](#what-is-a-type), an identifier, and an optional relation. +A user is a combination of a [type](#what-is-a-type), an identifier, and an optional relation. For example, @@ -378,7 +378,7 @@ A relationship tuple consists of: - an **[object](#what-is-an-object)**, e.g `repo:auth0/express_jwt`, `domain:auth0.com` or `channel:marketing` - a **[condition](#what-is-a-condition)** (optional), e.g. `{"condition": "in_allowed_ip_range", "context": {...}}` -An [authorization model](#what-is-an-authorization-model), together with relationship tuples, determinate whether a [relationship](#what-is-a-relationship) exists between a [user](#what-is-a-user) and an [object](#what-is-an-object). +An [authorization model](#what-is-an-authorization-model), together with relationship tuples, determine whether a [relationship](#what-is-a-relationship) exists between a [user](#what-is-a-user) and an [object](#what-is-an-object). Relationship tuples are usually shown in the following format: @@ -443,7 +443,7 @@ An [authorization model](#what-is-an-authorization-model), together with [relati ## What Are Direct And Implied Relationships? -A **direct relationship** (R) between user X and object Y means the relationship tuple (user=X, relation=R, object=Y) exists, and the authorization model for that relation allows the direct relationship because of [direct relationship type restrictions](./configuration-language.mdx#direct-relationship-type-restrictions)). +A **direct relationship** (R) between user X and object Y means the relationship tuple (user=X, relation=R, object=Y) exists, and the authorization model for that relation allows the direct relationship because of [direct relationship type restrictions](./configuration-language.mdx#direct-relationship-type-restrictions). An **implied (or computed) relationship** (R) exists between user X and object Y if user X is related to an object Z that is in a direct or implied relationship with object Y, and the authorization model allows it. @@ -466,7 +466,7 @@ An **implied (or computed) relationship** (R) exists between user X and object Y relationshipTuples={[ { _description: 'Everyone (`*`) of type user is directly related to the document', - user: '*', + user: 'user:*', relation: 'viewer', object: 'document:new-roadmap', }, @@ -482,7 +482,7 @@ An **implied (or computed) relationship** (R) exists between user X and object Y object: 'document:new-roadmap', }, { - _description: 'AND Anne of type user is a member of a userset (e.g. team:product#member)', + _description: 'AND Anne of type user is a member of the userset team:product#member', user: 'user:anne', relation: 'member', object: 'team:product#member', @@ -578,7 +578,7 @@ A **list objects request** is a call to the -List object requests are completed using the `listobjects` methods in the SDKs ([JavaScript SDK](https://www.npmjs.com/package/@openfga/sdk)/[Go SDK](https://github.com/openfga/go-sdk)/[.NET SDK](https://www.nuget.org/packages/OpenFga.Sdk)) by manually calling the [list objects endpoint](/api/service#Relationship%20Queries/ListObjects) using curl or in your code. +List objects requests are completed using the `listobjects` methods in the SDKs ([JavaScript SDK](https://www.npmjs.com/package/@openfga/sdk)/[Go SDK](https://github.com/openfga/go-sdk)/[.NET SDK](https://www.nuget.org/packages/OpenFga.Sdk)) by manually calling the [list objects endpoint](/api/service#Relationship%20Queries/ListObjects) using curl or in your code. The list objects endpoint responds with a list of objects for a given type that the user has the specified relationship with. @@ -632,7 +632,7 @@ For more information, see the [ListUsers API Reference](/api/service#Relationshi ## What Are Contextual Tuples? -Contextual tuples are tuples that can be added to a check request and only exist within the context of that particular request. +Contextual tuples are tuples that can be added to a Check request, a ListObjects request, a ListUsers request, or an Expand request. They only exist within the context of that particular request and are not persisted in the datastore.