セキュリティ マネージャー
REST API を使って、組織のセキュリティ マネージャーを管理します。
セキュリティ マネージャーについて
注: セキュリティ マネージャーロールはパブリック ベータ版であり、変更される可能性があります。
セキュリティ マネージャーは、Organization の所有者が Organization 内の任意の Team に割り当てることができる Organization レベルのロールです。 適用すると、チームのすべてのメンバーに、組織 全体のCODEセキュリティ に対するセキュリティアラートと設定をビューするためのアクセス許可と、組織 内のすべてのリポジトリの読み取りアクセス許可が付与されます。
警告: Team からセキュリティ マネージャーのロールを削除すると、その Team はセキュリティ アラートの管理や Organization 全体にわたる設定ができなくなります。ただし、ロールが割り当てられたときに付与されたリポジトリへの Team の読み取りアクセスはそのまま残ります。 不要な読み取りアクセスは手動で削除しなければなりません。 詳しくは、「Organization のリポジトリに対するチームのアクセスを管理する」を参照してください。
List security manager teams
Lists teams that are security managers for an organization. For more information, see "Managing security managers in your organization."
To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the read:org
scope.
GitHub Apps must have the administration
organization read permission to use this endpoint.
"List security manager teams" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
"List security manager teams" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
200 | OK |
"List security manager teams" のコード サンプル
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/security-managers
Response
Status: 200
[
{
"id": 1,
"node_id": "MDQ6VGVhbTE=",
"url": "https://api.github.com/teams/1",
"html_url": "https://github.com/orgs/github/teams/justice-league",
"name": "Justice League",
"slug": "justice-league",
"description": "A great team.",
"privacy": "closed",
"notification_setting": "notifications_enabled",
"permission": "admin",
"members_url": "https://api.github.com/teams/1/members{/member}",
"repositories_url": "https://api.github.com/teams/1/repos",
"parent": null
}
]
Add a security manager team
Adds a team as a security manager for an organization. For more information, see "Managing security for an organization for an organization."
To use this endpoint, you must be an administrator for the organization, and you must use an access token with the write:org
scope.
GitHub Apps must have the administration
organization read-write permission to use this endpoint.
"Add a security manager team" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
team_slug string 必須The slug of the team name. |
"Add a security manager team" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
204 | No Content |
409 | The organization has reached the maximum number of security manager teams. |
"Add a security manager team" のコード サンプル
curl -L \
-X PUT \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/security-managers/teams/TEAM_SLUG
Response
Status: 204
Remove a security manager team
Removes the security manager role from a team for an organization. For more information, see "Managing security managers in your organization team from an organization."
To use this endpoint, you must be an administrator for the organization, and you must use an access token with the admin:org
scope.
GitHub Apps must have the administration
organization read-write permission to use this endpoint.
"Remove a security manager team" のパラメーター
名前, Type, 説明 |
---|
accept string Setting to |
名前, Type, 説明 |
---|
org string 必須The organization name. The name is not case sensitive. |
team_slug string 必須The slug of the team name. |
"Remove a security manager team" の HTTP 応答状態コード
状態コード | 説明 |
---|---|
204 | No Content |
"Remove a security manager team" のコード サンプル
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/orgs/ORG/security-managers/teams/TEAM_SLUG
Response
Status: 204