> ## Documentation Index
> Fetch the complete documentation index at: https://proxy-docs.permify.co/llms.txt
> Use this file to discover all available pages before exploring further.
# Read Relationships
Read API allows for directly querying the stored graph data to display and filter stored relational tuples.
## OpenAPI
````yaml post /v1/tenants/{tenant_id}/data/relationships/read
openapi: 3.0.0
info:
title: Permify API
description: >-
Permify is an open source authorization service for creating fine-grained
and scalable authorization systems.
version: v1.6.10
contact:
name: API Support
url: https://github.com/Permify/permify/issues
email: hello@permify.co
license:
name: AGPL-3.0 license
url: https://github.com/Permify/permify/blob/master/LICENSE
servers: []
security: []
tags:
- name: Permission
- name: Watch
- name: Schema
- name: Data
- name: Bundle
- name: Tenancy
paths:
/v1/tenants/{tenant_id}/data/relationships/read:
post:
tags:
- Data
summary: read relationships
operationId: data.relationships.read
parameters:
- name: tenant_id
description: >-
Identifier of the tenant, if you are not using multi-tenancy (have
only one tenant) use pre-inserted tenant t1 for this
field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max
64 bytes.
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReadRelationshipsBody'
required: true
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/RelationshipReadResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- label: go
lang: go
source: >-
rr, err := client.Data.ReadRelationships(context.Background(),
&v1.Data.RelationshipReadRequest{
TenantId: "t1",
Metadata: &v1.Data.RelationshipReadRequestMetadata{
SnapToken: ""
},
Filter: &v1.TupleFilter{
Entity: &v1.EntityFilter{
Type: "organization",
Ids: []string{"1"},
},
Relation: "member",
Subject: &v1.SubjectFilter{
Type: "",
Id: []string{""},
Relation: ""
}
}
})
- label: node
lang: javascript
source: |-
client.data.readRelationships({
tenantId: "t1",
metadata: {
snap_token: "",
},
filter: {
entity: {
type: "organization",
ids: [
"1"
]
},
relation: "member",
subject: {
type: "",
ids: [],
relation: ""
}
}
}).then((response) => {
// handle response
})
- label: cURL
lang: curl
source: >-
curl --location --request POST
'localhost:3476/v1/tenants/{tenant_id}/data/relationships/read' \
--header 'Content-Type: application/json' \
--data-raw '{
metadata: {
snap_token: "",
},
filter: {
entity: {
type: "organization",
ids: [
"1"
]
},
relation: "member",
subject: {
type: "",
ids: [],
relation: ""
}
}
}'
components:
schemas:
ReadRelationshipsBody:
type: object
properties:
metadata:
$ref: '#/components/schemas/RelationshipReadRequestMetadata'
filter:
$ref: '#/components/schemas/TupleFilter'
page_size:
type: integer
format: int64
description: >-
page_size specifies the number of results to return in a single
page.
If more results are available, a continuous_token is included in the
response.
continuous_token:
type: string
description: >-
continuous_token is used in case of paginated reads to get the next
page of results.
description: >-
RelationshipReadRequest defines the structure of a request for reading
relationships.
It contains the necessary information such as tenant_id, metadata, and
filter for the read operation.
RelationshipReadResponse:
type: object
properties:
tuples:
type: array
items:
$ref: '#/components/schemas/Tuple'
description: >-
tuples is a list of the relationships retrieved in the read
operation, represented as entity-relation-entity triples.
continuous_token:
type: string
description: >-
continuous_token is used in the case of paginated reads to retrieve
the next page of results.
description: >-
RelationshipReadResponse defines the structure of the response after
reading relationships.
It includes the tuples representing the relationships and a continuous
token for handling result pagination.
Status:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
$ref: '#/components/schemas/Any'
RelationshipReadRequestMetadata:
type: object
properties:
snap_token:
type: string
description: >-
The snap token to avoid stale cache, see more details on [Snap
Tokens](../../operations/snap-tokens)
description: >-
RelationshipReadRequestMetadata defines the structure of the metadata
for a read request focused on relationships.
It includes the snap_token associated with a particular state of the
database.
TupleFilter:
type: object
properties:
entity:
$ref: '#/components/schemas/EntityFilter'
relation:
type: string
subject:
$ref: '#/components/schemas/SubjectFilter'
description: >-
TupleFilter is used to filter tuples based on the entity, relation and
the subject.
Tuple:
type: object
properties:
entity:
$ref: '#/components/schemas/Entity'
relation:
type: string
subject:
$ref: '#/components/schemas/Subject'
description: Tuple is a structure that includes an entity, a relation, and a subject.
Any:
type: object
properties:
'@type':
type: string
description: >-
A URL/resource name that uniquely identifies the type of the
serialized
protocol buffer message. This string must contain at least
one "/" character. The last segment of the URL's path must represent
the fully qualified name of the type (as in
`path/google.protobuf.Duration`). The name should be in a canonical
form
(e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that
they
expect it to use in the context of Any. However, for URLs which use
the
scheme `http`, `https`, or no scheme, one can optionally set up a
type
server that maps type URLs to message definitions as follows:
* If no scheme is provided, `https` is assumed.
* An HTTP GET on the URL must yield a [google.protobuf.Type][]
value in binary format, or produce an error.
* Applications are allowed to cache lookup results based on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)
Note: this functionality is not currently available in the official
protobuf release, and it is not used for type URLs beginning with
type.googleapis.com. As of May 2023, there are no widely used type
server
implementations and no plans to implement one.
Schemes other than `http`, `https` (or the empty scheme) might be
used with implementation specific semantics.
additionalProperties: {}
description: >-
`Any` contains an arbitrary serialized protocol buffer message along
with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form
of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
The pack methods provided by protobuf library will by default use
'type.googleapis.com/full.type.name' as the type URL and the unpack
methods only use the fully qualified type name after the last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield type
name "y.z".
JSON
====
The JSON representation of an `Any` value uses the regular
representation of the deserialized, embedded message, with an
additional field `@type` which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": ,
"lastName":
}
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
`value` which holds the custom JSON in addition to the `@type`
field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
EntityFilter:
type: object
properties:
type:
type: string
title: Type of the entity
ids:
type: array
items:
type: string
title: List of entity IDs
description: EntityFilter is used to filter entities based on the type and ids.
SubjectFilter:
type: object
properties:
type:
type: string
title: Type of the subject
ids:
type: array
items:
type: string
title: List of subject IDs
relation:
type: string
description: >-
SubjectFilter is used to filter subjects based on the type, ids and
relation.
Entity:
type: object
properties:
type:
type: string
id:
type: string
description: Entity represents an entity with a type and an identifier.
Subject:
type: object
properties:
type:
type: string
id:
type: string
relation:
type: string
description: >-
Subject represents an entity subject with a type, an identifier, and a
relation.
````