View as Markdown
Permit.io icon

Permit.io ACTION

Create Tenant

Mints a new isolated silo (such as a Customer Account or Organization) to manage multi-tenant permissions. 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 Tenant 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-tenant",
  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 Tenant 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
key Key string
A unique URL-friendly identifier for the tenant (alphanumeric, hyphens, underscores only, e.g. stripe-inc).
Required
name Name string
A descriptive display name for the tenant (e.g. Stripe Inc)
Required
description Description string
An optional longer description of the tenant
Optional
attributes Attributes object
Arbitrary JSON attributes used to enforce attribute-based access control (ABAC) policies (e.g. { "allowed_locations": ["US", "CA"] })
Optional

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-tenant
Version
0.0.2
App
Permit.io
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes