Tutorial: Configurar o usuário gerenciado pelo GitHub Enterprise (OIDC) para provisionamento automático de usuário
Este tutorial descreve as etapas que você precisa executar no GitHub Enterprise Managed User (OIDC) e na ID do Microsoft Entra para configurar o provisionamento automático de usuário. Quando configurada, a ID do Microsoft Entra provisiona e desprovisiona usuários e grupos automaticamente no GitHub Enterprise Managed User (OIDC) usando o serviço de provisionamento do Microsoft Entra. Para obter detalhes importantes sobre o que esse serviço faz, como ele funciona e perguntas frequentes, confira Automatizar o provisionamento e o desprovisionamento de usuários para aplicativos SaaS com o Microsoft Entra ID.
Observação
O GitHub EMU (Enterprise Managed User) é um tipo diferente de Conta do GitHub Enterprise. Se você não solicitou especificamente a instância de EMU, você tem uma conta do GitHub Enterprise padrão. Nesse caso, consulte a documentação para configurar o provisionamento de usuários que não sejam UME em sua organização. O provisionamento de usuário não é compatível com contas padrão do GitHub Enterprise, mas é compatível com organizações sob a conta padrão do GitHub Enterprise.
Funcionalidades com suporte
- Criar usuários no usuário gerenciado pelo GitHub Enterprise (OIDC)
- Remover os usuários do usuário gerenciado pelo GitHub Enterprise (OIDC) quando eles já não exigem acesso
- Manter os atributos de usuário sincronizados entre a ID do Microsoft Entra e o GitHub Enterprise Managed User (OIDC)
- Provisionar grupos e associações de grupos no usuário gerenciado pelo GitHub Enterprise (OIDC)
- Logon único para usuário gerenciado pelo GitHub Enterprise (OIDC) (recomendado).
Pré-requisitos
O cenário descrito neste tutorial pressupõe que você já tem os seguintes pré-requisitos:
- Um locatário do Microsoft Entra
- Uma das seguintes funções: Administrador de Aplicativos, Administrador de Aplicativos de Nuvem ou Proprietário do Aplicativo.
- Usuários Enterprise Gerenciados no GitHub Enterprise habilitados e configurados para fazer logon com o SSO do OIDC por meio do seu locatário do Microsoft Entra.
Observação
Essa integração também está disponível para uso no ambiente de Nuvem do Governo dos EUA do Microsoft Entra. Você pode encontrar esse aplicativo na Galeria de Aplicativos de Nuvem do Governo dos EUA do Microsoft Entra e configurá-lo da mesma forma que você faz isso na nuvem pública.
Etapa 1: Planeje a implantação do provisionamento
- Saiba mais sobre como funciona o serviço de provisionamento.
- Determine quem estará no escopo de provisionamento.
- Determine os dados que devem ser mapeados entre a ID do Microsoft Entra e o GitHub Enterprise Managed User.
Etapa 2: Configurar o GitHub Enterprise Managed User (OIDC) para dar suporte ao provisionamento com a ID do Microsoft Entra
A URL do locatário é
https://api.github.com/scim/v2/enterprises/{enterprise}
. Esse valor será inserido no campo URL do Locatário, na guia Provisionamento do aplicativo usuário gerenciado pelo GitHub Enterprise (OIDC).Como um administrador gerenciado do GitHub Enterprise, navegue até o canto superior direito - >clique na foto do seu perfil ->, em seguida, clique em Configurações.
Na barra lateral esquerda, clique em Configurações do desenvolvedor.
Na barra lateral esquerda, clique em Tokens de acesso pessoal.
Clique em Gerar novo token.
Selecione o escopo admin: enterprise para esse token.
Clique em Gerar Token.
Copie e salve o token secreto. Esse valor será inserido no campo Token secreto, na guia de Provisionamento do aplicativo usuário gerenciado pelo GitHub Enterprise (OIDC).
Etapa 3: Adicionar o GitHub Enterprise Managed User (OIDC) por meio da galeria de aplicativos do Microsoft Entra
Adicione o GitHub Enterprise Managed User (OIDC) por meio da galeria de aplicativos do Microsoft Entra para começar a gerenciar o provisionamento no GitHub Enterprise Managed User (OIDC). Caso já tenha configurado o usuário gerenciado pelo GitHub Enterprise (OIDC) para SSO, é possível usar o mesmo aplicativo. No entanto, recomendamos que você crie um aplicativo diferente ao testar a integração no início. Saiba mais sobre como adicionar um aplicativo da galeria aqui.
Etapa 4: Defina quem estará no escopo de provisionamento
O serviço de provisionamento do Microsoft Entra permite definir o escopo de quem será provisionado com base na atribuição ao aplicativo e ou com base em atributos do usuário/grupo. Se você optar por definir quem estará no escopo de provisionamento com base na atribuição, poderá usar as etapas a seguir para atribuir usuários e grupos ao aplicativo. Se você optar por definir quem estará no escopo de provisionamento com base somente em atributos do usuário ou do grupo, poderá usar um filtro de escopo, conforme descrito aqui.
Comece pequeno. Teste com um pequeno conjunto de usuários e grupos antes de implementar para todos. Quando o escopo de provisionamento é definido para usuários e grupos atribuídos, é possível controlar isso atribuindo um ou dois usuários ou grupos ao aplicativo. Quando o escopo é definido para todos os usuários e grupos, é possível especificar um atributo com base no filtro de escopo.
Se você precisar de funções adicionais, poderá atualizar o manifesto do aplicativo para adicionar novas funções.
Etapa 5: Configurar o provisionamento automático de usuário para o GitHub Enterprise Managed User (OIDC)
Essa seção orienta você pelas etapas para configurar o serviço de provisionamento do Microsoft Entra para criar, atualizar e desabilitar usuários e/ou grupos no TestApp com base em atribuições de usuário e/ou grupo na ID do Microsoft Entra.
Para configurar o provisionamento automático de usuário para o GitHub Enterprise Managed User (OIDC) na ID do Microsoft Entra:
Entre no Centro de administração do Microsoft Entra como pelo menos Administrador de Aplicativo de nuvem.
Navegue até Identidade>Aplicativos>Aplicativos empresariais
Na lista de aplicativos, selecione Usuário gerenciado pelo GitHub Enterprise (OIDC).
Selecione a guia Provisionamento.
Defina o Modo de Provisionamento como Automático.
Na seção Credenciais de Administrador, insira sua URL do locatário e o Token secreto do usuário gerenciado pelo GitHub Enterprise (OIDC). Clique em Testar Conectividade para verificar se a ID do Microsoft Entra pode se conectar ao GitHub Enterprise Managed User (OIDC). Se a conexão falhar, verifique se sua conta de usuário gerenciado pelo GitHub Enterprise (OIDC) criou o token secreto como um proprietário corporativo e tente novamente.
Em "URL do Locatário", digite
https://api.github.com/scim/v2/enterprises/YOUR_ENTERPRISE
, substituindo YOUR_ENTERPRISE pelo nome da sua conta corporativa.Por exemplo, se a URL da sua conta corporativa for https://github.com/enterprises/octo-corp, o nome da conta corporativa será octo-corp.
Em "Token secreto", cole o token de acesso pessoal com o escopo admin:enterprise que você havia criado.
No campo Notificação por Email, insira o endereço de email de uma pessoa ou grupo que deverá receber as notificações de erro de provisionamento e marque a caixa de seleção Enviar uma notificação por email quando ocorrer uma falha.
Clique em Salvar.
Na seção Mapeamentos, selecione Sincronizar usuários do Microsoft Entra com o GitHub Enterprise Managed User (OIDC).
Revise os atributos de usuário que serão sincronizados da ID do Microsoft Entra com o GitHub Enterprise Managed User (OIDC) na seção Mapeamento de Atributos. Os atributos selecionados como propriedades Correspondentes são usados para fazer a correspondência às contas no usuário gerenciado pelo GitHub Enterprise (OIDC) em operações de atualização. Se optar por alterar o atributo de destino correspondente, será necessário verificar se a API do usuário gerenciado pelo GitHub Enterprise (OIDC) dá suporte à filtragem de usuários com base nesse atributo. Selecione o botão Salvar para confirmar as alterações.
Atributo Type Com suporte para filtragem externalId String ✓ userName String ativo Boolean funções String displayName String name.givenName String name.familyName String name.formatted String emails[type eq "work"].value String emails[type eq "home"].value String emails[type eq "other"].value String Na seção Mapeamentos, selecione Sincronizar grupos do Microsoft Entra com o GitHub Enterprise Managed User (OIDC).
Revise os atributos de grupo que serão sincronizados da ID do Microsoft Entra com o GitHub Enterprise Managed User (OIDC) na seção Mapeamento de Atributos. Os atributos selecionados como propriedades Correspondentes são usados para fazer a correspondência dos grupos no usuário gerenciado pelo GitHub Enterprise (OIDC) em operações de atualização. Selecione o botão Salvar para confirmar as alterações.
Atributo Type Com suporte para filtragem externalId String ✓ displayName String membros Referência Para configurar filtros de escopo, consulte as seguintes instruções fornecidas no tutorial do Filtro de Escopo.
Para habilitar o serviço de provisionamento do Microsoft Entra no GitHub Enterprise Managed User (OIDC), altere o Status de Provisionamento para Ativado na seção Configurações.
Defina os usuários e/ou os grupos que deseja provisionar no usuário gerenciado pelo GitHub Enterprise (OIDC) escolhendo os valores desejados em Escopo na seção Configurações.
Quando estiver pronto para provisionar, clique em Salvar.
Essa operação começa o ciclo de sincronização inicial de todos os usuários e grupos definidos no Escopo na seção Configurações. O ciclo inicial leva mais tempo para ser executado do que os ciclos subsequentes, que ocorrem aproximadamente a cada 40 minutos, desde que o serviço de provisionamento do Microsoft Entra esteja em execução.
Etapa 6: Monitorar a implantação
Depois de configurar o provisionamento, use os seguintes recursos para monitorar a implantação:
- Use os logs de provisionamento para determinar quais usuários foram provisionados com êxito ou não
- Confira a barra de progresso para ver o status do ciclo de provisionamento e saber como fechá-la para concluir
- Se a configuração de provisionamento parecer estar em um estado não íntegro, o aplicativo entrará em quarentena. Saiba mais sobre os estados de quarentena aqui.
Recursos adicionais
- Gerenciamento do provisionamento de conta de usuário para Aplicativos Empresariais
- O que é o acesso a aplicativos e logon único com o Microsoft Entra ID?