Bulk add team members | Sample

2 parameters · 1 body field

enterprisestringrequired

The enterprise slug.

enterprise-teamstringrequired

The enterprise team slug, or the enterprise team ID.

The GitHub user handles to add to the enterprise team.

usernamesarray<string>required

The GitHub user handles to add to the team.

1 status code

200Returns an array of the GitHub user objects added to the enterprise team.

namestringoptional

emailstringoptional

loginstringrequired

idintegerrequired

node_idstringrequired

avatar_urlstringrequired

gravatar_idstringrequired

urlstringrequired

html_urlstringrequired

followers_urlstringrequired

following_urlstringrequired

gists_urlstringrequired

starred_urlstringrequired

subscriptions_urlstringrequired

organizations_urlstringrequired

repos_urlstringrequired

events_urlstringrequired

received_events_urlstringrequired

typestringrequired

site_adminbooleanrequired

starred_atstringoptional

user_view_typestringoptional

Error handling

enterprise, enterprise-team, and usernames must identify the target enterprise team and the GitHub users to add. usernames must be an array containing GitHub user handles, and each array item must be a string.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.add.create({
  enterprise: "example",
  enterpriseTeam: "example",
  usernames: "octocat",
});

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Request

Response

Errors