Form.io ACTION
List Roles
List all roles in the Form.io project, including the built-in Administrator, Authenticated, and Anonymous roles. Form.io returns up to
limit records (default 10); if you receive a full page there may be more — raise limit (up to 1000) or page with skip to retrieve them all. See the documentation.- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Form.io account once, then configure and run List Roles 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: "form_io-list-roles",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
form_io: { authProvisionId: "apn_xxxxxxx" },
limit: 10,
skip: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "form_io-list-roles",
"configured_props": {
"form_io": { "authProvisionId": "apn_xxxxxxx" },
"limit": 10,
"skip": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "form_io",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "form_io-list-roles",
arguments: {
limit: 10,
skip: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
limit Limit | integer | Maximum number of records to return. Min 1, max 1000. Optional |
skip Skip | integer | Number of records to skip (for pagination). Optional |
sort Sort | string | Field name to sort by; prefix with - for descending (e.g. -created, title). 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
- form_io-list-roles
- Version
- 0.0.1
- App
- Form.io
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗