View as Markdown

WorkOS Integration

Manage WorkOS organizations, AuthKit users, memberships, and directory sync

The WorkOS integration provides access to manage WorkOS organizations, AuthKit users, memberships, and directory sync through the Integrate MCP server.

Installation

The WorkOS integration is included with the SDK:

import { workosIntegration } from "integrate-sdk/server";

Setup

Add WorkOS to your server configuration. Provide credentials via environment variables or integration config:

import { createMCPServer, workosIntegration } from "integrate-sdk/server";
 
export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    workosIntegration({
      // See configuration options below
    }),
  ],
});

Client-Side Usage

import { client } from "integrate-sdk";
 
const result = await client.workos.listOrganizations({});
 
console.log(result);

Environment Variables

  • WORKOS_API_KEY (when supported by this integration)

Configuration Options

export interface WorkOSIntegrationOptions {
  /** WorkOS API key (defaults to WORKOS_API_KEY env var) */
  apiKey?: string;

Tools

workos_list_organizations

List organizations

export interface WorkosListOrganizationsParams {
    before?: string;

workos_get_organization

Get organization

export interface WorkosGetOrganizationParams { organization_id: string }

workos_create_organization

Create organization

export interface WorkosCreateOrganizationParams {
    name: string;

workos_update_organization

Update organization

export interface WorkosUpdateOrganizationParams {
    organization_id: string;

workos_list_users

List users

export interface WorkosListUsersParams {
    before?: string;

workos_get_user

Get user

export interface WorkosGetUserParams { user_id: string }

workos_list_organization_memberships

List organization memberships

export interface WorkosListOrganizationMembershipsParams {
    organization_id?: string;

workos_list_directories

List directories

export interface WorkosListDirectoriesParams {
    before?: string;

workos_get_directory

Get directory

export interface WorkosGetDirectoryParams { directory_id: string }

workos_list_directory_users

List directory users

export interface WorkosListDirectoryUsersParams {
    directory?: string;

workos_get_directory_user

Get directory user

export interface WorkosGetDirectoryUserParams { directory_user_id: string }

Notes

  • Category: Identity & Access
  • Authentication mode: API key