Puntos de conexión de API de REST para administradores de seguridad

Acerca de los administradores de seguridad

Nota: El rol de administrador de seguridad se encuentra en versión beta pública y está sujeto a cambios.

"Administrador de seguridad" es un rol a nivel organizacional que los propietarios de las organizaciones pueden asignar a cualquier equipo dentro de ellas. Cuando se aplica, este otorga a todos los miembros de un equipo los permisos para visualizar alertas y ajustes de seguridad en toda tu organización, así como para leer permisos para todos los repositorios de la misma.

Advertencia: Al quitar el rol de administrador de seguridad de un equipo, se quitará también la capacidad del equipo para administrar las alertas y la configuración de seguridad en toda la organización. No obstante, el equipo mantendrá el acceso de lectura a los repositorios a los que se le concedió cuando se asignó el rol. Debes eliminar manualmente cualquier acceso de lectura no deseado. Para obtener más información, vea «Administrar el acceso de equipo a un repositorio de la organización».

List security manager teams

Lists teams that are security managers for an organization. For more information, see "Managing security managers in your organization."

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

Parámetros para "List security manager teams"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "List security manager teams"

status code	Descripción
`200`	OK

Ejemplos de código para "List security manager teams"

Ejemplo de solicitud

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

Adds a team as a security manager for an organization. For more information, see "Managing security for an organization for an organization."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

Parámetros para "Add a security manager team"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`team_slug` string Requerido The slug of the team name.

Códigos de estado de respuesta HTTP para "Add a security manager team"

status code	Descripción
`204`	No Content
`409`	The organization has reached the maximum number of security manager teams.

Ejemplos de código para "Add a security manager team"

Ejemplo de solicitud

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

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."

The authenticated user must be an administrator for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Parámetros para "Remove a security manager team"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`org` string Requerido The organization name. The name is not case sensitive.
`team_slug` string Requerido The slug of the team name.

Códigos de estado de respuesta HTTP para "Remove a security manager team"

status code	Descripción
`204`	No Content

Ejemplos de código para "Remove a security manager team"

Ejemplo de solicitud

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