使用WorkOS时遇「Role is invalid」错误，请求排查方案

我在使用WorkOS创建组织成员时，触发了「Role is invalid」错误。推测原因是代码中指定的角色未在WorkOS系统中定义或未关联到对应组织。

相关代码如下：

'use server';

import {WorkOS} from "@workos-inc/node";
import {revalidatePath} from "next/cache";
import {redirect} from "next/navigation";

const workos = new WorkOS(process.env.WORKOS_API_KEY);

export async function createCompany(companyName: string, userId:string) {
  const org = await workos.organizations.createOrganization({name: companyName});
  await workos.userManagement.createOrganizationMembership({
    userId,
    organizationId: org.id,
    roleSlug: 'admin',
  });
  revalidatePath('/new-listing');
  redirect('/new-listing');
}

问题分析 #

错误核心在于roleSlug: 'admin'参数——WorkOS要求创建组织成员时使用的角色必须是已在系统中创建，且已分配给目标组织的角色。若该角色不存在，或未关联到刚创建的org组织，就会抛出「Role is invalid」错误。

解决方案 #

• 检查并创建角色
  登录WorkOS控制台，进入「User Management」→「Roles」页面，确认slug为admin的角色是否存在。若不存在，需先创建该角色。

• 关联角色到组织
  新创建的组织默认无关联角色，可通过两种方式处理：

  1. 在WorkOS控制台手动将admin角色分配给目标组织；
  2. 通过API在创建组织后立即关联角色：

     // 在创建组织成员之前添加角色关联
     await workos.userManagement.createOrganizationRoleAssignment({
       organizationId: org.id,
       roleSlug: 'admin',
     });
     

• 验证角色slug准确性
  确保代码中的roleSlug与控制台中角色的slug完全一致（注意大小写敏感）。

内容的提问来源于stack exchange，提问作者Kabir Potdar