PEpermit
Relationship tuples

List Relationship Tuples Detailed

Changed on

Lists the relationship tuples defined within an environment.

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

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

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

Query parameters

pageinteger

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

per_pageinteger

The number of results per page (max 100).

tenantstring

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

relationstring

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

object_typestring

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

Response

Successful Response

total_countinteger required
page_countinteger

Example response

{
  "data": [
    {
      "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",
      "subject_details": {
        "key": "permitio",
        "resource": "organization",
        "tenant": "default",
        "attributes": {}
      },
      "relation_details": {
        "key": "owner",
        "name": "owner",
        "description": "owner relation"
      },
      "object_details": {
        "key": "opal",
        "resource": "repo",
        "tenant": "default",
        "attributes": {
          "private": "false",
          "owner": "permitio"
        }
      },
      "tenant_details": {
        "key": "github",
        "name": "GitHub",
        "description": "A code hosting platform for version control and collaboration",
        "attributes": {
          "allowed_locations": [
            "US",
            "CA"
          ]
        }
      }
    }
  ]
}

Changes

  • 97d5f9fec6b0Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

  • 05b99f06db87Revision changes
    • info

      endpoint added