このバージョンの GitHub Enterprise はこの日付をもって終了となりました: 2023-03-15. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise にアップグレードします。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください。
REST API ドキュメントの一部は最近移動されました。 探しているものが見つからない場合は、Actions REST API ページを試してみてください。
組織
この REST API を使って、企業の組織を作成します。
Create an organization
"Create an organization" のパラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept string Setting to |
本文のパラメーター |
名前, Type, 説明 |
login string 必須The organization's username. |
admin string 必須The login of the user who will manage this organization. |
profile_name string The organization's display name. |
"Create an organization" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
201 | Created |
"Create an organization" のコード サンプル
post/admin/organizations
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://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://HOSTNAME/orgs/github",
"repos_url": "https://HOSTNAME/orgs/github/repos",
"events_url": "https://HOSTNAME/orgs/github/events",
"hooks_url": "https://HOSTNAME/orgs/github/hooks",
"issues_url": "https://HOSTNAME/orgs/github/issues",
"members_url": "https://HOSTNAME/orgs/github/members{/member}",
"public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
"description": "A great organization"
}
Update an organization name
"Update an organization name" のパラメーター
ヘッダー |
---|
名前, Type, 説明 |
accept string Setting to |
パス パラメーター |
名前, Type, 説明 |
org string 必須The organization name. The name is not case sensitive. |
本文のパラメーター |
名前, Type, 説明 |
login string 必須The organization's new name. |
"Update an organization name" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
202 | Accepted |
"Update an organization name" のコード サンプル
patch /admin /organizations /{org}
curl -L \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://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"
}