View as Markdown
Permit.io icon

Permit.io ACTION

Create Relationship Tuple

Defines a granular relationship between two resources, enabling advanced Relationship-Based Access Control (ReBAC). See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Permit.io account once, then configure and run Create Relationship Tuple from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "permit_io-create-relationship-tuple",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    permit_io: { authProvisionId: "apn_xxxxxxx" },
    projId: "Project ID",
    envId: "Environment ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Relationship Tuple inputs
Property Type Description
projId Project ID string
The project key or ID
Required Dynamic
envId Environment ID string
The environment key or ID
Required Dynamic
subject Subject string
The resource instance assigned to the new relation. Use the format resource_type:instance_key (e.g. organization:permitio).
Required
relation Relation string
The relation to assign between the subject and object (e.g. owner, member)
Required
object Object string
The resource instance on which the relation is assigned. Use the format resource_type:instance_key (e.g. repo:opal).
Required
tenant Tenant string
The tenant the subject and object belong to. Required if the resource instances don't exist yet so they can be created implicitly.
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
permit_io-create-relationship-tuple
Version
0.0.2
App
Permit.io
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes