セキュリティマネージャー

REST API を使って、組織のセキュリティマネージャーを管理します。

セキュリティマネージャーについて

注: セキュリティマネージャーロールはパブリックベータ版であり、変更される可能性があります。

セキュリティマネージャーは、Organization の所有者が Organization 内の任意の Team に割り当てることができる Organization レベルのロールです。適用すると、Team のすべてのメンバーに、Organization 全体のセキュリティアラートと設定を管理するためのアクセス許可と、Organization 内のすべてのリポジトリの読み取りアクセス許可が付与されます。

List security manager teams

Works with GitHub Apps

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.

Parameters

Headers
名前, Type, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名前, Type, 説明
`org`stringRequired The organization name. The name is not case sensitive.

HTTP response status codes

Status code	説明
`200`	OK

Code samples

get/orgs/{org}/security-managers

curl \
  -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",
    "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

Works with GitHub Apps

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.

Parameters

Headers
名前, Type, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名前, Type, 説明
`org`stringRequired The organization name. The name is not case sensitive.
`team_slug`stringRequired The slug of the team name.

HTTP response status codes

Status code	説明
`204`	No Content
`409`	The organization has reached the maximum number of security manager teams.

Code samples

put/orgs/{org}/security-managers/teams/{team_slug}

curl \
  -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

Works with GitHub Apps

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.

Parameters

Headers
名前, Type, 説明
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
名前, Type, 説明
`org`stringRequired The organization name. The name is not case sensitive.
`team_slug`stringRequired The slug of the team name.

HTTP response status codes

Status code	説明
`204`	No Content

Code samples

delete/orgs/{org}/security-managers/teams/{team_slug}

curl \
  -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

セキュリティ マネージャー