API を使用したユーザー管理

このトピックでは、Megaport API を使用してユーザーアカウントを管理する概要を提供します。新しいユーザーを招待する方法、ユーザーの詳細を更新する方法、ユーザーを無効化する方法、および招待されたユーザーを削除する方法について説明します。

注記

組織が Identity Provider (IdP) を使用している場合、Megaport は Security Assertion Markup Language (SAML) を使用したシングルサインオン (SSO) を設定して、ユーザーを一元管理することをお勧めします。

SSO は以下の利点を提供します：

自動ユーザー管理 – IdP でユーザーを無効にすると、Megaport のアクセスが自動的に取り消されます。
手作業の削減 – API 経由でユーザーを手動で無効化する必要がありません。

詳細については、シングルサインオンの設定を参照してください。

以下の手順は、SSO 統合が使用されていない環境向けに意図されています。

新しいユーザーを招待する

Company Admin ユーザーは、/v2/employment エンドポイントを使用して、既存の会社にユーザーを招待することで、新しいユーザーアカウントを作成できます。

詳細については、既存の会社に新しいユーザーを招待するを参照してください。

ユーザーの詳細を表示する

特定のユーザーの詳細（役職、名前、メールアドレス、電話番号、ユーザー名、ユーザーの有効/無効、Megaport ユーザーロール、Megaport 権限、ユーザーに対して多要素認証 (MFA) が有効かどうか）を、v2/employee/:employeeId エンドポイントを使用して表示できます。

詳細については、ユーザーの詳細を表示するを参照してください。

ユーザーの詳細を更新する

名前、電話番号、ロールなどのユーザーの詳細を /v2/employee/:employeeId エンドポイントを使用して更新できます。

さらに、active 属性を false に設定してユーザーを無効化することができます。

注記

一度ログインしたユーザーを完全に削除することはできません。代わりに、アクセスを取り消し、システム内に情報を保持するために無効化する必要があります。
まだ招待を承諾していない招待されたユーザーのみ削除できます。

詳細については、ユーザーの詳細を更新するを参照してください。

招待されたユーザーを削除する

あなたの会社に招待されたがまだログインしていないユーザーを /v2/employee/:employeeId エンドポイントを使用して削除できます。誤ってユーザーを招待した場合や、提供されたメールアドレスに誤りがあった場合に便利です。一度作成されたユーザーのメールアドレスは修正できないため、ユーザーを削除してから正しい詳細を使用してアカウントを再作成します。

注記

ログインしたユーザーを完全に削除することはできません。代わりに、active 属性を false に設定してユーザーを無効化し、アクセスを取り消し、システム内に情報を保持する必要があります。
まだ招待を承諾していない招待されたユーザーのみ削除できます。

詳細については、招待されたユーザーを削除するを参照してください。

会社のすべてのユーザーを一覧表示する

会社に関連するすべてのユーザーのリストを作成し、その詳細とステータスを含めることができます。これには、/v2/employment エンドポイントを使用します。

詳細については、会社ユーザーの一覧表示を参照してください。

ユーザーのアクティビティを表示する

Portal でのユーザーの動作を監視および監査するのに役立つ、アクセスログとアクティビティの詳細を取得します。

詳細については、ユーザーアクティビティを参照してください。

多要素認証 (MFA) のリセット

ユーザーが MFA に問題を抱えたり、新しいモバイルデバイスを登録したりする場合、/v2/employee/:employeeId/mfa エンドポイントを使用して MFA をリセットできます。

詳細については、個人の多要素認証をリセットするを参照してください。

多要素認証 (MFA) を無効化する

グローバルにオプションとして設定されており、現在 MFA を使用してログインしている場合、ユーザーの MFA を無効化できます。これには、/v2/employee/:employeeId/mfa エンドポイントを使用します。

詳細については、個人の多要素認証を無効化するを参照してください。