Gerenciando usuários com a API
Este tópico fornece uma visão geral do gerenciamento de contas de usuário usando a API da Megaport. Ele descreve como convidar novos usuários, atualizar detalhes do usuário, desativar usuários e excluir usuários convidados.
Nota
Se sua organização usa um provedor de identidade (IdP), a Megaport recomenda configurar Single Sign-On (SSO) com Security Assertion Markup Language (SAML) para gerenciar usuários centralmente.
SSO oferece estas vantagens:
- Gerenciamento automático de usuários – Desabilitar um usuário no seu IdP revoga automaticamente o acesso dele à Megaport.
- Menos trabalho manual – Não é necessário desativar usuários manualmente pela API.
Para mais informações, consulte Configurar Single Sign-On.
Os procedimentos a seguir se destinam a ambientes em que a integração SSO não está em uso.
Convidar novos usuários
Um administrador da empresa pode criar novas contas de usuário convidando usuários para uma empresa existente usando o endpoint /v2/employment.
Para mais informações, consulte Invite (Add) a New User to an Existing Company.
Visualizar detalhes do usuário
Você pode visualizar os detalhes de um usuário específico, como cargo, nome, endereço de email, número de telefone, nome de usuário, se o usuário está ativo ou não, função do usuário na Megaport, permissões da Megaport, e se a autenticação multifator (MFA) está habilitada para o usuário, usando o endpoint v2/employee/:employeeId.
Para mais informações, consulte Show User Details.
Atualizar detalhes do usuário
Você pode atualizar detalhes do usuário, como nome, número de telefone e funções, usando o endpoint /v2/employee/:employeeId.
Além disso, você pode desativar usuários definindo o atributo active como false.
Nota
- Você não pode excluir permanentemente usuários que já fizeram login. Em vez disso, você deve desativá-los para revogar seu acesso, mantendo suas informações no sistema.
- Somente usuários convidados que ainda não aceitaram o convite podem ser excluídos.
Para mais informações, consulte Update User Details.
Excluir usuários convidados
Você pode excluir usuários que foram convidados para sua empresa, mas ainda não fizeram login, usando o endpoint /v2/employee/:employeeId. Isso é útil se o usuário errado foi convidado ou se houve um erro no endereço de email fornecido. Como o endereço de email de um usuário não pode ser modificado após a criação, você pode excluir o usuário e então recriar a conta com os detalhes corretos.
Nota
- Você não pode excluir permanentemente usuários que já fizeram login. Em vez disso, você deve desativá-los para revogar seu acesso, mantendo suas informações no sistema. Para desativar um usuário, defina o atributo
activecomofalseusando o endpoint/v2/employee/:employeeId. - Somente usuários convidados que ainda não aceitaram o convite podem ser excluídos.
Para mais informações, consulte Delete Invited User.
Listar todos os usuários da empresa
Você pode criar uma lista de todos os usuários associados à sua empresa, incluindo seus detalhes e status, usando o endpoint /v2/employment.
Para mais informações, consulte List Company Users.
Visualizar atividade do usuário
Acesse logs e detalhes de atividade para acompanhar as ações dos usuários no Portal. Esse recurso ajuda a monitorar e auditar o comportamento do usuário.
Para mais informações, consulte User Activity.
Redefinir autenticação multifator (MFA)
Se um usuário encontrar problemas com a MFA ou quiser registrar um novo dispositivo móvel, você pode redefinir a MFA usando o endpoint /v2/employee/:employeeId/mfa.
Para mais informações, consulte Reset Person Multi-Factor Authentication.
Desabilitar autenticação multifator (MFA)
Você pode desabilitar a MFA para um usuário quando a MFA estiver definida como opcional globalmente para a sua empresa e o usuário estiver usando a MFA para fazer login, usando o endpoint /v2/employee/:employeeId/mfa.
Para mais informações, consulte Disable Person Multi-Factor Authentication.