Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Relationship tuples

List Relationship Tuples

Lists the relationship tuples defined within an environment.

get/v2/facts/{proj_id}/{env_id}/relationship_tuples

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Query parameters

detailedboolean

If true, will return the full subject and object resource instances.

If true, will return the full subject and object resource instances.

include_total_countboolean

If true, returns the list of resource instances and the total count.

If true, returns the list of resource instances and the total count.

pageinteger

Page number of the results to fetch, starting at 1.

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

The number of results per page (max 100).

tenantstring

The tenant key or id to filter by

The tenant key or id to filter by

subjectstring

The subject to filter by, accepts either the resource instance id or resource_type:resource_instance

The subject to filter by, accepts either the resource instance id or resource_type:resource_instance

relationstring

The relation id or key to filter by

The relation id or key to filter by

objectstring

The object to filter by, accepts either the resource instance id or resource_type:resource_instance

The object to filter by, accepts either the resource instance id or resource_type:resource_instance

object_typestring

The object type to filter by, accepts resource type id or key

The object type to filter by, accepts resource type id or key

subject_typestring

The subject type to filter by, accepts resource type id or key

The subject type to filter by, accepts resource type id or key

Response

Successful Response

OR

Example response

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "subject": "organization:permitio",
    "relation": "owner",
    "object": "repo:opal",
    "tenant": "stripe-inc",
    "subject_id": "7c60d51f-b44e-4682-87d6-449835ea4d11",
    "relation_id": "405d8375-3514-403b-8c43-83ae74cfe022",
    "object_id": "12f84e49-af17-4b0c-8cd7-01258769c2ba",
    "tenant_id": "40ef0e48-a11f-4963-a229-e396c9f7e733",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]