Gestionnaires de sécurité

Utilisez l’API REST pour gérer les gestionnaires de sécurité dans une organisation.

À propos des gestionnaires de sécurité

Remarque : Le rôle de responsable de la sécurité est en version bêta publique et peut faire l’objet de modifications.

Le responsable de sécurité est un rôle au niveau de l’organisation que les propriétaires d’organisation peuvent attribuer à n’importe quelle équipe d’une organisation. Lorsqu'il est appliqué, il donne à chaque membre de l'équipe des autorisations pour afficher les alertes de sécurité et gérer les paramètres de sécurité du code dans l'ensemble de votre organisation. Il fournit également des autorisations d'accès en lecture pour tous les référentiels de l'organisation.

Avertissement : La suppression du rôle de gestionnaire de sécurité pour une équipe supprime la capacité de l’équipe à gérer les alertes et les paramètres de sécurité dans l’organisation, l’équipe conservant néanmoins l’accès en lecture aux dépôts accordé lors de l’attribution du rôle. Vous devez supprimer manuellement les accès en lecture non souhaités. Pour plus d’informations, consultez « Gestion de l’accès de l’équipe à un dépôt de l’organisation ».

List security manager teams

Compatible avec 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.

Paramètres pour « List security manager teams »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`org` string Obligatoire The organization name. The name is not case sensitive.

Codes d’état de la réponse HTTP pour « List security manager teams »

Code d’état	Description
`200`	OK

Exemples de code pour « List security manager teams »

get/orgs/{org}/security-managers

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/security-managers

Response

Status: 200

[
  {
    "id": 1,
    "node_id": "MDQ6VGVhbTE=",
    "url": "https://HOSTNAME/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://HOSTNAME/teams/1/members{/member}",
    "repositories_url": "https://HOSTNAME/teams/1/repos",
    "parent": null
  }
]

Add a security manager team

Compatible avec 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.

Paramètres pour « Add a security manager team »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`org` string Obligatoire The organization name. The name is not case sensitive.
`team_slug` string Obligatoire The slug of the team name.

Codes d’état de la réponse HTTP pour « Add a security manager team »

Code d’état	Description
`204`	No Content
`409`	The organization has reached the maximum number of security manager teams.

Exemples de code pour « Add a security manager team »

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

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/security-managers/teams/TEAM_SLUG

Response

Status: 204

Remove a security manager team

Compatible avec 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.

Paramètres pour « Remove a security manager team »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`org` string Obligatoire The organization name. The name is not case sensitive.
`team_slug` string Obligatoire The slug of the team name.

Codes d’état de la réponse HTTP pour « Remove a security manager team »

Code d’état	Description
`204`	No Content

Exemples de code pour « Remove a security manager team »

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/security-managers/teams/TEAM_SLUG

Response

Status: 204