Visão geral de usuários · BreezeAuth Docs

Um usuário é uma pessoa que faz parte da sua organização: um funcionário, um prestador de serviços, um parceiro. Cada usuário pode entrar com o BreezeAuth e abrir as aplicações às quais a sua organização dá acesso.

Os usuários são gerenciados em Usuários › Usuários Humanos no console de administração. Integrações e automações não usam as contas das pessoas: elas têm identidades próprias, listadas na aba Usuários de Serviço, ao lado. Veja Usuários de serviço.

O que o BreezeAuth guarda sobre cada usuário

Informação	Exemplos
Informações Básicas	Nome, sobrenome e endereço de e-mail. O e-mail é o que a pessoa usa para entrar.
Informações Profissionais	Cargo, departamento, matrícula, centro de custo, unidade organizacional, local de trabalho.
Contato	Telefone e telefone comercial.
Documentos e Endereço	CPF e endereço.
Papel administrativo	O que a pessoa pode fazer no console de administração, se puder. Veja Papéis administrativos.
Status	Se a pessoa pode usar o BreezeAuth na sua organização neste momento. Veja Status.
Tipo de conta	Gerenciado ou Convidado, definido pelo domínio do e-mail. Veja Tipos de conta.

Apenas o nome e o e-mail são obrigatórios. Os outros campos do perfil são opcionais, e muitos deles podem ser enviados às suas aplicações quando as pessoas entram, então vale a pena preenchê-los.

Conceitos principais

Usuário: O lugar de uma pessoa na sua organização: o perfil, o papel administrativo e o status dela. Cada organização mantém o seu próprio registro da pessoa, então a mesma pessoa pode pertencer a várias organizações, com papel e perfil diferentes em cada uma.
Conta: O acesso da pessoa ao BreezeAuth: endereço de e-mail, senha, passkeys e autenticação multifator (MFA). Uma conta pode estar ligada a usuários em várias organizações.
Tipo de conta: Se a conta é Gerenciada pela sua organização ou pertence a um Convidado. Ele define quanto controle a sua organização tem sobre a conta.
Papel administrativo: O que o usuário pode fazer no console de administração, como Administrador ou Auditor. A maioria das pessoas não tem papel administrativo: elas só entram nas suas aplicações.
Status: Se o usuário tem acesso neste momento: Ativo, Inativo, aguardando um convite ou aguardando a sua revisão.

Tipos de conta

O tipo de conta de cada usuário é definido automaticamente pelo domínio do e-mail. Você não o escolhe.

Tipo de conta	Quem	Como entra	A sua organização controla
Gerenciado	Pessoas com e-mail em um dos seus domínios verificados	Criado diretamente, com uma senha inicial, e já pode entrar	A própria conta: políticas, MFA, sessões, e-mail, exclusão
Convidado	Todos os demais, como parceiros, fornecedores ou pessoas com e-mail pessoal	Recebe um convite e precisa aceitá-lo	Apenas o lugar da pessoa na sua organização: perfil, papel, status

Essa diferença importa principalmente quando você modifica, desativa ou exclui alguém. Cada página desta seção destaca quando ela se aplica. A comparação completa está em Usuários gerenciados e convidados.

Dica: se a sua empresa ainda não verificou o domínio dela, todos os usuários que você adicionar serão convidados. Verifique o seu domínio primeiro para gerenciar as contas dos seus colegas. Veja Verificação de domínios.

Status

Status	O que significa	Pode entrar nas suas aplicações
Ativo	O usuário faz parte da organização.	Sim, nas que foram atribuídas a ele
Inativo	Um administrador desativou o usuário. O perfil, os grupos e as atribuições são mantidos, então você pode reativá-lo depois.	Não
Pendente	Um convidado recebeu o convite e ainda não o aceitou.	Não
Convite recusado	O convidado recusou o convite.	Não
Revisão pendente	O domínio do e-mail da pessoa foi verificado depois que a conta dela foi criada, e um administrador precisa confirmá-la. Veja Revisar contas pendentes.	Não

Apenas usuários ativos com um papel administrativo podem usar o console de administração.

O ciclo de vida de um usuário

AdicionadoUm administrador cria um usuário gerenciado, ou convida um convidado, em Usuários › Novo Usuário.
AtivoUsuários gerenciados ficam ativos na hora. Convidados ficam ativos quando aceitam o convite.
Com acessoO usuário é adicionado a grupos e recebe aplicações, diretamente ou pelos grupos.
Desativado ou excluídoQuando a pessoa sai, desative-a para manter o registro, ou exclua-a.

O passo a passo está em Adicionar e gerenciar usuários.

Para desenvolvedores: na API do BreezeAuth, os usuários são chamados de memberships: o vínculo entre a conta de uma pessoa e uma organização. Por exemplo, os usuários são lidos e alterados em /organizations/{organizationsUuid}/memberships, o identificador deles é membershipsUuid, e os eventos de webhook sobre eles se chamam membership.created, membership.updated e membership.deleted. No console de administração e no restante desta documentação, eles são simplesmente usuários.

Próximos passos

Entenda as diferenças entre usuários gerenciados e convidados.
Adicione e gerencie usuários no console de administração.
Entenda como funcionam os convites para convidados.
Escolha o papel administrativo certo para quem ajuda a gerenciar o BreezeAuth.
Proteja os seus usuários gerenciados com as ferramentas de segurança da conta.