View as Markdown
Form.io icon

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)

SCHEMA

Inputs

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

List Roles inputs
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