Skip to main content

Administrar cuentas empresariales

Puedes administrar tu cuenta empresarial y las organizaciones que le pertenecen con la API de GraphQL.

Acerca de administrar cuentas empresariales con GraphQL

Para ayudarte a monitorear y hacer cambios en tu organización y mantener el cumplimiento, puedes utilizar la API de Cuentas Empresariales y la API de Bitácoras de Auditoría, las cuales se encuentran disponibles únicamente como API de GraphQL.

Las terminales de cuenta empresarial funcionan tanto para GitHub Enterprise Cloud y GitHub Enterprise Server.

GraphQL permite solicitar y devolver solo los datos que especifique. Por ejemplo, puede crear una consulta GraphQL o solicitar información para ver los nuevos miembros que se han agregado a su organización. O bien puede realizar un cambio para invitar a un administrador a su cuenta empresarial.

Con Audit Log API, puede supervisar si alguien hace lo siguiente:

  • Accede a la configuración de la organización o del repositorio.
  • Cambia los permisos.
  • Agrega o quita usuarios de una organización, un repositorio o un equipo.
  • Promueve usuarios a administradores.
  • Cambia los permisos de una aplicación de GitHub Apps.

Audit Log API permite mantener copias de los datos de los registros de auditoría. Para las consultas realizadas con la API de Bitácoras de Auditoria, la respuesta de GraphQL puede incluir datos de hasta 90 a 120 días. Para obtener una lista de los campos disponibles con Audit Log API, vea la "Interfaz AuditEntry".

Con la API de Cuentas Empresariales puedes:

  • Listar y revisar todas las organizaciones y repositorios que pertenecen a tu cuenta empresarial.
  • Cambiar la configuración de la cuenta empresarial.
  • Configurar políticas para la configuración en tu cuenta empresarial y sus organizaciones.
  • Invitar administradores a tu cuenta empresarial.
  • Crear nuevas organizaciones en tu cuenta empresarial.

Para obtener una lista de los campos disponibles con Enterprise Accounts API, vea "Campos y tipos de GraphQL para Enterprise Accounts API".

Comenzar a utilizar GraphQL para cuentas empresariales

Sigue estos pasos para comenzar a utilizar GraphQL para administrar tus cuentas empresariales:

  • Autenticarte con un token de acceso personal
  • Elegir un cliente de GraphQL o utilizar el Explorador de GraphQL
  • Configurar Insomnia para utilizar la API de GraphQL

Para obtener algunas consultas de ejemplo, vea "Una consulta de ejemplo con Enterprise Accounts API".

1. Autenticación con el token de acceso personal

  1. Para autenticarte con GraphQL, necesitas generar un token de acceso personal (PAT) desde la configuración de desarrollador. Para más información, vea "Creación de un token de acceso personal".

  2. Porporciona permisos de control total a tu token de acceso personal para las áreas de GHES a las que quisieras acceder. Para tener permiso total a los repositorios privados, organizaciones, equipos, datos de usuario y acceso a la facturación empresarial y datos de perfil, te recomendamos que selecciones estos alcances para tu token de acceso personal:

    • repo
    • admin:org
    • user
    • admin:enterprise

    Los alcances específicos para la cuenta empresarial son:

    • admin:enterprise: proporciona control total de las empresas (incluye manage_runners:enterprise, manage_billing:enterprise y read:enterprise)
    • manage_billing:enterprise: lectura y escritura de datos de facturación de la empresa.
    • manage_runners:enterprise: acceso para administrar ejecutores y grupos de ejecutores de empresa de Acciones de GitHub.
    • read:enterprise: lectura de datos del perfil de empresa.
  3. Copia tu token de acceso personal y mantenlo en un lugar seguro hasta que lo agregues a tu cliente de GraphQL.

2. Elección de un cliente de GraphQL

Te recomendamos utilizar GraphiQL u otro cliente independiente de GraphQL que te permita configurar la URL base.

También podrás considerar utilizar estos clientes de GraphQL:

Los siguientes pasos utilizarán Insomnia.

3. Configuración de Insomnia para usar GraphQL API de GitHub con cuentas de empresa

  1. Agregue la URL base y el método POST al cliente de GraphQL. Cuando use GraphQL para solicitar información (consultas), cambiar información (mutaciones), o transferir datos mediante la API de GitHub, el método HTTP predeterminado es POST y la URL base sigue esta sintaxis:

    • Para la instancia empresarial: https://<HOST>/api/graphql
    • Para GitHub Enterprise Cloud: https://api.github.com/graphql
  2. Para la autenticación, abra el menú de opciones de autenticación y seleccione Token de portador. A continuación, agrega tu token de acceso personal, el cual habías copiado.

    Opciones de permisos para el token de acceso personal

    Opciones de permisos para el token de acceso personal

  3. Incluye la información del encabezado.

    • Agregue Content-Type como encabezado y application/json como valor. Encabezado estándar Encabezado con valor de versión preliminar para Audit Log API

Ahora estás listo para comenzar a hacer consultas.

Un ejemplo de consulta utilizando la API de Cuentas Empresariales

Esta consulta de GraphQL solicita la cantidad total de repositorios de private en cada una de las organizaciones del dispositivo mediante Enterprise Accounts API. Para personalizar esta consulta, reemplace <enterprise-account-name> por el identificador de la cuenta de empresa. Por ejemplo, si la cuenta de empresa se encuentra en https://github.com/enterprises/octo-enterprise, reemplace <enterprise-account-name> por octo-enterprise.

query privateRepositoriesByOrganization($slug: String!) {
  enterprise(slug: $slug) {
    ...enterpriseFragment
  }
}

fragment enterpriseFragment on Enterprise {
  ... on Enterprise{
    name
    organizations(first: 100){
      nodes{
        name
        ... on Organization{
          name
          repositories(privacy: PRIVATE){
            totalCount
          }
        }
      }
    }
  }
}

# Passing our Enterprise Account as a variable
variables {
  "slug": "<enterprise-account-name>"
}

En la siguiente consulta de GraphQL se muestra lo complicado que es recuperar la cantidad de repositorios private en cada organización sin usar Enterprise Account API. Nota que la API de Cuentas Empresariales de GraphQL ha hecho esta tarea más simple para las empresas, ya que solo necesitas personalizar una sola variable. Para personalizar esta consulta, reemplace <name-of-organization-one> y <name-of-organization-two>, etc., por los nombres de la organización en la instancia.

# Each organization is queried separately
{
  organizationOneAlias: organization(login: "name-of-organization-one") {
    # How to use a fragment
    ...repositories
  }
  organizationTwoAlias: organization(login: "name-of-organization-two") {
    ...repositories
  }
  # organizationThreeAlias ... and so on up-to lets say 100
}

## How to define a fragment
fragment repositories on Organization {
  name
  repositories(privacy: PRIVATE){
    totalCount
  }
}

Consulta a cada organización por separado

query privateRepositoriesByOrganization {
  organizationOneAlias: organization(login: "<name-of-organization-one>") {
    # How to use a fragment
    ...repositories
  }
  organizationTwoAlias: organization(login: "<name-of-organization-two>") {
    ...repositories
  }
  # organizationThreeAlias ... and so on up-to lets say 100
}
# How to define a fragment
fragment repositories on Organization {
  name
  repositories(privacy: PRIVATE){
    totalCount
  }
}

Esta consulta de GraphQL solicita las últimas 5 entradas de bitácora para una organización empresarial. Para personalizar esta consulta, reemplace <org-name> y <user-name>.

{
  organization(login: "<org-name>") {
    auditLog(last: 5, query: "actor:<user-name>") {
      edges {
        node {
          ... on AuditEntry {
# Get Audit Log Entry by 'Action'
            action
            actorLogin
            createdAt
# User 'Action' was performed on
           user{
              name
                email
            }
          }
        }
      }
    }
  }
}

Para más información sobre cómo empezar a trabajar con GraphQL, vea "Introducción a GraphQL" y "Formación de llamadas con GraphQL".

Campos y tipos de GraphQL para la API de Cuentas Empresariales

Aquí tienes un resumen de las nuevas consultas, mutaciones y tipos definidos por modelos disponibles para utilizarse con la API de Cuentas Empresariales.

Para más información sobre as nuevas consultas, mutaciones y tipos definidos por el esquema disponibles para usar con Enterprise Accounts API, vea la barra lateral con definiciones detalladas de GraphQL desde cualquier página de referencia de GraphQL.

Puedes acceder a los documentos de referencia desde dentro del explorador de GraphQL en GitHub. Para más información, vea "Uso del explorador". Para obtener otra información, como los detalles de autenticación y límite de frecuencia, consulte las guías.