如何通过邮箱地址使用gh CLI将GitHub组织成员加入团队？

核心问题是你所有API调用都直接用了邮箱作为用户标识，但GitHub的团队成员管理API只接受GitHub用户名，不支持直接传入邮箱（网页UI会自动完成邮箱到用户名的映射，但API不会）。

正确步骤：先通过邮箱获取用户名，再添加到团队 #

1. 通过邮箱查询对应的GitHub用户名
   使用GitHub的用户搜索API，根据邮箱找到用户的登录名：

   USERNAME=$(gh api search/users -q "email:${USER_EMAIL}" --jq '.items[0].login')
   

   这里${USER_EMAIL}是你要添加的用户邮箱，命令会返回匹配该邮箱的第一个用户的用户名。

2. 使用用户名调用团队成员API添加用户
   用获取到的用户名调用最新版的团队成员关系API：

   gh api \
     --method PUT \
     -H "Accept: application/vnd.github+json" \
     -H "X-GitHub-Api-Version: 2022-11-28" \
     /orgs/${{ github.repository_owner }}/teams/${TEAM_SLUG}/memberships/${USERNAME} \
     -f "role=member"
   

完整示例脚本 #

# 替换为目标邮箱和团队Slug
USER_EMAIL="target-user@example.com"
TEAM_SLUG="your-team-slug"

# 获取用户名
USERNAME=$(gh api search/users -q "email:${USER_EMAIL}" --jq '.items[0].login')

if [ -z "$USERNAME" ]; then
  echo "未找到对应邮箱的GitHub用户"
  exit 1
fi

# 添加到团队
gh api \
  --method PUT \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /orgs/${{ github.repository_owner }}/teams/${TEAM_SLUG}/memberships/${USERNAME} \
  -f "role=member"

关键说明 #

• 确保你的gh CLI有足够权限：需要组织的团队管理权限，并且认证的账号能访问该团队
• 如果邮箱对应多个GitHub用户，items[0]会取第一个，你可以根据需要调整逻辑
• 若用户已经在团队中，该API会返回200状态码，不会报错，可安全重复调用

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