Files
simstudioai--sim/apps/sim/tools/clerk/get_organization.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

104 lines
3.5 KiB
TypeScript

import { createLogger } from '@sim/logger'
import type {
ClerkApiError,
ClerkGetOrganizationParams,
ClerkGetOrganizationResponse,
ClerkOrganization,
} from '@/tools/clerk/types'
import type { ToolConfig } from '@/tools/types'
const logger = createLogger('ClerkGetOrganization')
export const clerkGetOrganizationTool: ToolConfig<
ClerkGetOrganizationParams,
ClerkGetOrganizationResponse
> = {
id: 'clerk_get_organization',
name: 'Get Organization from Clerk',
description: 'Retrieve a single organization by ID or slug from Clerk',
version: '1.0.0',
params: {
secretKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'The Clerk Secret Key for API authentication',
},
organizationId: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description:
'The ID or slug of the organization to retrieve (e.g., org_2NNEqL2nrIRdJ194ndJqAHwEfxC or my-org-slug)',
},
},
request: {
url: (params) => `https://api.clerk.com/v1/organizations/${params.organizationId?.trim()}`,
method: 'GET',
headers: (params) => {
if (!params.secretKey) {
throw new Error('Clerk Secret Key is required')
}
return {
Authorization: `Bearer ${params.secretKey}`,
'Content-Type': 'application/json',
}
},
},
transformResponse: async (response: Response) => {
const data: ClerkOrganization | ClerkApiError = await response.json()
if (!response.ok) {
logger.error('Clerk API request failed', { data, status: response.status })
throw new Error(
(data as ClerkApiError).errors?.[0]?.message || 'Failed to get organization from Clerk'
)
}
const org = data as ClerkOrganization
return {
success: true,
output: {
id: org.id,
name: org.name,
slug: org.slug ?? null,
imageUrl: org.image_url ?? null,
hasImage: org.has_image ?? false,
membersCount: org.members_count ?? null,
pendingInvitationsCount: org.pending_invitations_count ?? null,
maxAllowedMemberships: org.max_allowed_memberships ?? 0,
adminDeleteEnabled: org.admin_delete_enabled ?? false,
createdBy: org.created_by ?? null,
createdAt: org.created_at,
updatedAt: org.updated_at,
publicMetadata: org.public_metadata ?? {},
success: true,
},
}
},
outputs: {
id: { type: 'string', description: 'Organization ID' },
name: { type: 'string', description: 'Organization name' },
slug: { type: 'string', description: 'Organization slug', optional: true },
imageUrl: { type: 'string', description: 'Organization image URL', optional: true },
hasImage: { type: 'boolean', description: 'Whether organization has an image' },
membersCount: { type: 'number', description: 'Number of members', optional: true },
pendingInvitationsCount: {
type: 'number',
description: 'Number of pending invitations',
optional: true,
},
maxAllowedMemberships: { type: 'number', description: 'Max allowed memberships' },
adminDeleteEnabled: { type: 'boolean', description: 'Whether admin delete is enabled' },
createdBy: { type: 'string', description: 'Creator user ID', optional: true },
createdAt: { type: 'number', description: 'Creation timestamp' },
updatedAt: { type: 'number', description: 'Last update timestamp' },
publicMetadata: { type: 'json', description: 'Public metadata' },
success: { type: 'boolean', description: 'Operation success status' },
},
}