跳轉到

使用 API 管理使用者帳戶

本主題概述如何使用 Megaport API 管理使用者帳戶。內容說明如何邀請新使用者、更新使用者詳細資料、停用使用者,以及刪除已邀請的使用者。

備註

如果貴組織使用 Identity Provider(IdP),Megaport 建議使用 Security Assertion Markup Language(SAML)設定 Single Sign-On(SSO)以集中管理使用者。

SSO 具有以下優點:

  • 自動化使用者管理 – 在 IdP 停用某位使用者會自動撤銷其 Megaport 存取權。
  • 減少手動作業 – 無須透過 API 手動停用使用者。

如需詳細資料,請參閱 設定單一登入

以下程序適用於未使用 SSO 整合的環境。

邀請新使用者

Company Admin 可以使用 /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。

如需詳細資料,請參閱 Disable Person Multi-Factor Authentication