使用 API 管理用户
本主题概述了使用 Megaport API 管理用户账户。它介绍了如何邀请新用户、更新用户详情、停用用户，以及删除已邀请的用户。
注意
如果你的组织使用身份提供商（IdP），Megaport 建议使用 Security Assertion Markup Language（SAML）配置 Single Sign-On（SSO），以集中管理用户。
SSO 具有以下优势：
- 自动化用户管理 – 在你的 IdP 中禁用用户会自动撤销其 Megaport 访问权限。
- 减少手动操作 – 无需通过 API 手动停用用户。
更多信息，请参阅 设置单点登录。
以下步骤适用于未使用 SSO 集成的环境。
邀请新用户
公司管理员可以使用 /v2/employment 端点，将用户邀请到现有公司，从而创建新的用户账户。
注意
电子邮箱地址必须唯一，并且不能来自免费邮箱域（如 Gmail、Yahoo 或 Outlook）。如果使用了无效的邮箱域，API 将返回 400 Bad Request 错误。
更多信息，请参阅 Invite (Add) a New User to an Existing Company。
查看用户详情
你可以使用 v2/employee/:employeeId 端点查看特定用户的详细信息，例如职位、姓名、电子邮箱地址、电话号码、用户名、用户是否为启用状态、Megaport 用户角色、Megaport 权限，以及该用户是否启用了多因素认证（MFA）。
更多信息，请参阅 Show User Details。
更新用户详情
你可以使用 /v2/employee/:employeeId 端点更新用户详情，例如姓名、电话号码和角色。
此外，可以将 active 属性设置为 false 来停用用户。
注意
- 对于曾经登录过的用户，无法永久删除。你必须将其停用，以撤销其访问权限，同时在系统中保留其信息。
- 只有尚未接受邀请的已邀请用户可以被删除。
更多信息，请参阅 Update User Details。
删除已邀请的用户
你可以使用 /v2/employee/:employeeId 端点删除已被邀请到你公司但尚未登录的用户。如果错误地邀请了用户，或所提供的电子邮箱地址有误，这将非常有用。由于用户的电子邮箱地址一旦创建便无法修改，你可以先删除该用户，然后使用正确的详情重新创建账户。
注意
- 对于已登录过的用户，无法永久删除。相应地，你必须将其停用，以撤销其访问权限，同时在系统中保留其信息。要停用用户，请使用
/v2/employee/:employeeId端点将active属性设置为false。 - 只有尚未接受邀请的已邀请用户可以被删除。
更多信息，请参阅 Delete Invited User。
列出公司内的所有用户
你可以使用 /v2/employment 端点列出与你的公司关联的所有用户，包括其详情和状态。
更多信息，请参阅 List Company Users。
查看用户活动
访问日志和活动详情，以在 Portal 中跟踪用户操作。此功能有助于监控和审计用户行为。
更多信息，请参阅 User Activity。
重置多因素认证（MFA）
如果用户遇到 MFA 问题或希望注册新的移动设备，可以使用 /v2/employee/:employeeId/mfa 端点重置 MFA。
更多信息，请参阅 Reset Person Multi-Factor Authentication。
禁用多因素认证（MFA）
当你的公司在全局将 MFA 设置为可选，并且该用户当前使用 MFA 登录时，可以使用 /v2/employee/:employeeId/mfa 端点为该用户禁用 MFA。