We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.
組織
この REST API を使って、企業の組織を作成します。
組織の管理について
これらのエンドポイントは、認証されたサイト管理者のみが使用できます。 通常のユーザーは 404 応答を受け取ります。
Create an organization
パラメーター
| ヘッダー |
|---|
| 名前, Type, 説明 |
acceptstringSetting to |
| 本文のパラメーター |
| 名前, Type, 説明 |
loginstring必須The organization's username. |
adminstring必須The login of the user who will manage this organization. |
profile_namestringThe organization's display name. |
HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
201 | Created |
コード サンプル
post/admin/organizations
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/admin/organizations \
-d '{"login":"github","profile_name":"GitHub, Inc.","admin":"monalisaoctocat"}'Response
Status: 201{
"login": "github",
"id": 1,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"url": "https://api.github.com/orgs/github",
"repos_url": "https://api.github.com/orgs/github/repos",
"events_url": "https://api.github.com/orgs/github/events",
"hooks_url": "https://api.github.com/orgs/github/hooks",
"issues_url": "https://api.github.com/orgs/github/issues",
"members_url": "https://api.github.com/orgs/github/members{/member}",
"public_members_url": "https://api.github.com/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}Update an organization name
パラメーター
| ヘッダー |
|---|
| 名前, Type, 説明 |
acceptstringSetting to |
| パス パラメーター |
| 名前, Type, 説明 |
orgstring必須The organization name. The name is not case sensitive. |
| 本文のパラメーター |
| 名前, Type, 説明 |
loginstring必須The organization's new name. |
HTTP 応答状態コード
| 状態コード | 説明 |
|---|---|
202 | Accepted |
コード サンプル
patch
curl \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://HOSTNAME/api/v3/admin/organizations/ORG \
-d '{"login":"the-new-octocats"}'Response
Status: 202{
"message": "Job queued to rename organization. It may take a few minutes to complete.",
"url": "https://<hostname>/api/v3/organizations/1"
}