Verwalten von Benutzern mit der API
Dieses Thema bietet einen Überblick über die Verwaltung von Benutzerkonten mit der Megaport API. Es beschreibt, wie neue Benutzer eingeladen, Benutzerdetails aktualisiert, Benutzer deaktiviert und eingeladene Benutzer gelöscht werden.
Hinweis
Wenn Ihre Organisation einen Identity Provider (IdP) verwendet, empfiehlt Megaport, Single Sign-On (SSO) mit Security Assertion Markup Language (SAML) einzurichten, um Benutzer zentral zu verwalten.
SSO bietet folgende Vorteile:
- Automatisches Benutzermanagement – Das Deaktivieren eines Benutzers in Ihrem IdP entzieht automatisch den Zugriff auf Megaport.
- Weniger manueller Aufwand – Es ist nicht erforderlich, Benutzer manuell über die API zu deaktivieren.
Weitere Informationen finden Sie unter Einrichten von Single Sign-On.
Die folgenden Verfahren sind für Umgebungen gedacht, in denen keine SSO-Integration verwendet wird.
Neue Benutzer einladen
Ein Company Admin kann neue Benutzerkonten erstellen, indem er Benutzer über den Endpoint /v2/employment zu einem bestehenden Unternehmen einlädt.
Weitere Informationen finden Sie unter Invite (Add) a New User to an Existing Company.
Benutzerdetails anzeigen
Sie können die Details eines bestimmten Benutzers anzeigen, z. B. Position, Name, E-Mail-Adresse, Telefonnummer, Benutzername, ob der Benutzer aktiv ist oder nicht, Megaport Benutzerrolle, Megaport Berechtigungen und ob die Multi-Faktor-Authentifizierung (MFA) für den Benutzer aktiviert ist, über den Endpoint v2/employee/:employeeId.
Weitere Informationen finden Sie unter Show User Details.
Benutzerdetails aktualisieren
Sie können Benutzerdetails wie Name, Telefonnummer und Rollen über den Endpoint /v2/employee/:employeeId aktualisieren.
Zusätzlich können Sie Benutzer deaktivieren, indem Sie das Attribut active auf false setzen.
Hinweis
- Benutzer, die sich bereits einmal angemeldet haben, können nicht dauerhaft gelöscht werden. Stattdessen müssen Sie sie deaktivieren, um ihren Zugriff zu entziehen und ihre Informationen im System zu behalten.
- Nur eingeladene Benutzer, die die Einladung noch nicht angenommen haben, können gelöscht werden.
Weitere Informationen finden Sie unter Update User Details.
Eingeladene Benutzer löschen
Sie können Benutzer, die zu Ihrem Unternehmen eingeladen wurden, sich aber noch nicht angemeldet haben, über den Endpoint /v2/employee/:employeeId löschen. Dies ist nützlich, wenn der falsche Benutzer eingeladen wurde oder die angegebene E-Mail-Adresse fehlerhaft war. Da die E-Mail-Adresse eines Benutzers nach der Erstellung nicht geändert werden kann, können Sie den Benutzer löschen und das Konto anschließend mit den korrekten Angaben neu erstellen.
Hinweis
- Benutzer, die sich bereits angemeldet haben, können nicht dauerhaft gelöscht werden. Stattdessen müssen Sie sie deaktivieren, um ihren Zugriff zu entziehen und ihre Informationen im System zu behalten. Um einen Benutzer zu deaktivieren, setzen Sie das Attribut
activemit dem Endpoint/v2/employee/:employeeIdauffalse. - Nur eingeladene Benutzer, die die Einladung noch nicht angenommen haben, können gelöscht werden.
Weitere Informationen finden Sie unter Delete Invited User.
Alle Benutzer des Unternehmens auflisten
Sie können über den Endpoint /v2/employment eine Liste aller Benutzer erstellen, die Ihrem Unternehmen zugeordnet sind, einschließlich ihrer Details und Status.
Weitere Informationen finden Sie unter List Company Users.
Benutzeraktivität anzeigen
Greifen Sie auf Protokolle und Aktivitätsdetails zu, um Benutzeraktionen im Portal nachzuverfolgen. Diese Funktion unterstützt die Überwachung und Prüfung des Benutzerverhaltens.
Weitere Informationen finden Sie unter User Activity.
Multi-Faktor-Authentifizierung (MFA) zurücksetzen
Wenn ein Benutzer Probleme mit MFA hat oder ein neues Mobilgerät registrieren möchte, können Sie MFA über den Endpoint /v2/employee/:employeeId/mfa zurücksetzen.
Weitere Informationen finden Sie unter Reset Person Multi-Factor Authentication.
Multi-Faktor-Authentifizierung (MFA) deaktivieren
Sie können MFA für einen Benutzer deaktivieren, wenn MFA in Ihrem Unternehmen global auf optional gesetzt ist und der Benutzer derzeit MFA zur Anmeldung verwendet, über den Endpoint /v2/employee/:employeeId/mfa.
Weitere Informationen finden Sie unter Disable Person Multi-Factor Authentication.