View as Markdown
Form.io icon

Form.io ACTION

Get Role

Retrieve a single role by its ID from the Form.io project. Obtain the role ID from List Roles (it is the role's 24-character hex _id, e.g. 64f8a1b2c3d4e5f60718293a). 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 Get Role 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-get-role",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    form_io: { authProvisionId: "apn_xxxxxxx" },
    roleId: "Role 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.

Get Role inputs
Property Type Description
roleId Role ID string
The _id of the role. Run List Roles first to obtain valid role IDs.
Required

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-get-role
Version
0.0.1
App
Form.io
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes