View as Markdown
Orbit icon

Orbit ACTION

Get Member by Identity

Provide a source and one of username/uid/email params to return a member with that identity, if one exists. Common values for source include github, twitter, and email. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Orbit account once, then configure and run Get Member by Identity 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: "orbit-get-member-by-identity",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orbit: { authProvisionId: "apn_xxxxxxx" },
    workspaceSlug: "Workspace Slug",
    activityTypes: "Activity Type",
  },
})

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 Member by Identity inputs
Property Type Description
workspaceSlug Workspace Slug string
The workspace slug to use
Required Dynamic
activityTypes Activity Type string
The activity type to use
Optional Dynamic
source Source string
The source of the identity.
Optional
sourceHost Source Host string
The host of the source.
Optional
uid UID string
The UID of the identity.
Optional
username Username string
The username of the identity.
Optional
email Email string
The email of the identity.
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
orbit-get-member-by-identity
Version
0.0.3
App
Orbit
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes