v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB

Relationship tuples

Create Relationship Tuple

Create a relationship between two resource instances using a relation.

post/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").

env_idstring required

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

Request body

subjectstring required

the resource instance assigned the new relation (accepts either the resource instance id or resource_key:resource_instance_key)

relationstring required

the relation to assign between the subject and object

objectstring required

the resource instance on which the new relation is assigned (accepts either the resource instance id or resource_key:resource_instance_key)

tenantstring

The tenant the subject and object belong to, if the resource instances don't exist yet, the tenant is required to create them. otherwise it is ignored

Example request

{
  "subject": "organization:permitio",
  "relation": "owner",
  "object": "repo:opal",
  "tenant": "public"
}

Response

Successful Response

subjectstring required

resource_key:resource_instance_key of the subject

relationstring required

key of the assigned relation

objectstring required

resource_key:resource_instance_key of the object

idstring uuid required

Unique id of the relationship tuple

tenantstring required

The tenant the relationship tuple is associated with

subject_idstring uuid required

Unique id of the subject

relation_idstring uuid required

Unique id of the relation

object_idstring uuid

Unique id of the object (null = all resources of this type)

tenant_idstring uuid required

Unique id of the tenant

organization_idstring uuid required

Unique id of the organization that the relationship tuple belongs to.

project_idstring uuid required

Unique id of the project that the relationship tuple belongs to.

environment_idstring uuid required

Unique id of the environment that the relationship tuple belongs to.

created_atstring date-time required

Date and time when the relationship tuple was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the relationship tuple was created (ISO_8601 format).

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"
}