automacao-identidade-ad/README.md

144 lines
7.2 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Plataforma Unificada de Trabalho Digital
![Status](https://img.shields.io/badge/status-em%20desenvolvimento-yellowgreen)
![PowerShell](https://img.shields.io/badge/PowerShell-5.1%2B-blue)
![Licença](https://img.shields.io/badge/licen%C3%A7a-propriet%C3%A1ria-red)
Conjunto de scripts e aplicações para automação de tarefas de gestão de identidades (AD/Exchange) para o projeto **Plataforma Unificada de Trabalho Digital**.
---
## 📜 Sumário
- [Visão Geral do Projeto](#-visão-geral-do-projeto)
- [🚀 Módulos e Funcionalidades Principais](#-módulos-e-funcionalidades-principais)
- [🛠️ Tecnologias Utilizadas](#-tecnologias-utilizadas)
- [🏁 Começando (Getting Started)](#-começando-getting-started)
- [Pré-requisitos](#pré-requisitos)
- [Instalação](#instalação)
- [📖 Como Usar](#-como-usar)
- [🗺️ Fases do Projeto (Roadmap)](#-fases-do-projeto-roadmap)
- [🤝 Como Contribuir](#-como-contribuir)
---
## 🌟 Visão Geral do Projeto
Este projeto detalha a criação de uma **Plataforma Unificada de Trabalho Digital**, um investimento estratégico projetado para **reduzir custos operacionais**, **aumentar a segurança e a conformidade (LGPD)** e **melhorar a agilidade organizacional**.
O objetivo é transformar processos manuais de gestão de identidades (criação de usuários, resets de senha, gestão de grupos, desligamentos) em um fluxo de trabalho automatizado, seguro e eficiente, orquestrado por um portal de autoatendimento para colaboradores, gestores e RH.
Os principais objetivos incluem:
- **Automatizar 80% das solicitações de TI rotineiras**.
- **Unificar o acesso a sistemas-chave** como Exchange, Nextcloud e Zammad.
- **Mitigar riscos de segurança** através da automação de processos de desligamento e higienização de contas inativas.
- **Empoderar colaboradores e gestores** com ferramentas de autoatendimento.
Para um guia completo sobre a arquitetura e o funcionamento de cada script, consulte a **[Wiki do Projeto](link-para-a-wiki-do-seu-gitea)**.
## 🚀 Módulos e Funcionalidades Principais
A plataforma é dividida nos seguintes módulos, conforme o dossiê do projeto:
#### Módulo 1: Portal do Colaborador (Hub Digital)
- Autenticação Segura via LDAPS
- Dashboard Unificado com Widgets (AD, Exchange, Nextcloud, Zammad)
- Alteração de Senha (Self-Service)
- Atualização de Foto de Perfil
#### Módulo 2: Portal do Gestor
- Criação de Novos Colaboradores a partir de templates
- Criação e Gestão de Grupos de Distribuição
#### Módulo 3: Gestão de Colaboradores (RH)
- Painel de Consulta e Edição de Colaboradores Ativos
- Processo de Desligamento Totalmente Automatizado
#### Módulo 4: Automação e Governança (Backend)
- Higienização Agendada de Contas de Usuários e Computadores Inativos
- Mapeamento e Atualização Automática do Organograma no AD
#### Módulo 5: Painel de Auditoria e Relatórios
- Geração de Relatórios de Atividade de Login
- Exportação Segura de Logs de Auditoria da Plataforma
## 🛠️ Tecnologias Utilizadas
- **Backend (Automação):** PowerShell 5.1+
- **Sistemas Alvo:** Active Directory, Microsoft Exchange
- **Backend (API):** *(A definir, ex: Node.js, Python/Flask, C#/.NET)*
- **Frontend:** *(A definir, ex: React, Vue.js, Angular)*
- **Banco de Dados (Configurações):** *(A definir, ex: PostgreSQL, MariaDB)*
## 🏁 Começando (Getting Started)
Para configurar um ambiente de desenvolvimento local, siga os passos abaixo.
### Pré-requisitos
- PowerShell 5.1 ou superior
- Módulo `ActiveDirectory` (instalado via RSAT - Ferramentas de Administração de Servidor Remoto)
- Ferramentas de Gerenciamento do Exchange
- Acesso a um ambiente de Active Directory e Exchange para testes
- *(Outros pré-requisitos para a stack web, como Node.js, Python, etc.)*
### Instalação
1. **Clone o repositório:**
```sh
git clone [URL_DO_SEU_REPOSITORIO_GITEA]
cd portal-gestao-automation
```
2. **Configuração do Backend:**
*(Instruções para configurar a API que irá executar os scripts)*
3. **Configuração do Frontend:**
*(Instruções para instalar dependências e iniciar o servidor de desenvolvimento do frontend)*
4. **Configuração dos Scripts:**
- Nenhuma instalação é necessária para os scripts, mas garanta que a política de execução do PowerShell permita a execução de scripts locais:
```powershell
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```
## 📖 Como Usar
Os scripts de automação estão localizados na pasta `/scripts` e são projetados para serem chamados pela API do backend. Para testes manuais, podem ser executados diretamente via PowerShell.
**Exemplo (Criação de Usuário em Massa):**
```powershell
# 1. Prepare as credenciais de forma segura
$clientCred = Get-Credential
$exchangeCred = Get-Credential
# 2. Execute o script apontando para o arquivo CSV
.\scripts\identity\New-ADUserFromTemplate.ps1 -CsvPath "C:\temp\novos_usuarios.csv" -ClientADServer "dc01.local" -ClientADCredential $clientCred -ExchangeADServer "mail.local" -ExchangeADCredential $exchangeCred
```
> Para detalhes completos sobre os parâmetros de cada script e a estrutura dos arquivos de entrada, consulte a **Wiki do Projeto**.
## 🗺️ Fases do Projeto (Roadmap)
A implementação seguirá as fases estratégicas definidas no dossiê do projeto para mitigar riscos e entregar valor de forma contínua.
| Fase | Título | Duração Estimada | Entregáveis Chave |
| :--: | ------------------------------------------ | :--------------: | --------------------------------------------------------- |
| 1 | Análise e Arquitetura Estratégica | 3-4 Semanas | Blueprint técnico, DPIA/LGPD, planejamento de extensão AD |
| 2 | Prova de Conceito (PoC) de Riscos | 2 Semanas | Validação de integrações complexas (Multi-AD, SIEM) |
| 3 | MVP - Autoatendimento Essencial | 6-8 Semanas | Portal com login, troca de senha e atualização de perfil |
| 4 | Módulo de Gestão (Gestores e RH) | 5-6 Semanas | Criação de usuários, grupos, e módulo de desligamento |
| 5 | Módulos de Automação e Auditoria | 5-7 Semanas | Scripts de higienização, organograma e painel de auditoria|
| 6 | Integração com Sistemas Externos | 4-6 Semanas | Conectores (Exchange, Nextcloud, Zammad), dashboard unificado|
| 7 | Painel de Gestão e Configurações | 3-4 Semanas | Painel de admin para gerenciar variáveis e integrações |
| 8 | Lançamento e Melhoria Contínua | Contínuo | Plataforma em produção, monitoramento de KPIs e treinamento |
## 🤝 Como Contribuir
Contribuições são o que tornam a comunidade um lugar incrível para aprender, inspirar e criar. Qualquer contribuição que você fizer será **muito apreciada**.
1. Faça um Fork do Projeto
2. Crie sua Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Faça o Commit de suas alterações (`git commit -m 'Add some AmazingFeature'`)
4. Faça o Push para a Branch (`git push origin feature/AmazingFeature`)
5. Abra um Pull Request
---