Skip to main content
Die deutsche Sprachversion wurde als Serviceleistung für Sie durch maschinelle Übersetzung erstellt. Bei eventuellen Unstimmigkeiten hat die englische Sprachversion Vorrang.

Mandantenmanagement-API verstehen

Beitragende
PDFs

Sie können Systemmanagementaufgaben mit der REST-API für das Mandantenmanagement anstelle der Mandantenmanager-Benutzeroberfläche ausführen. Möglicherweise möchten Sie beispielsweise die API zur Automatisierung von Vorgängen verwenden oder mehrere Einheiten, wie beispielsweise Benutzer, schneller erstellen.

Die Mandantenmanagement-API:

  • Verwendet die Open Source API-Plattform von Swagger. Swagger bietet eine intuitive Benutzeroberfläche, über die Entwickler und nicht-Entwickler mit der API interagieren können. Die Swagger-Benutzeroberfläche bietet vollständige Details und Dokumentation für jeden API-Vorgang.

  • Verwendet Versionierung zur Unterstützung unterbrechungsfreier Upgrades.

So greifen Sie auf die Swagger-Dokumentation für die Mandantenmanagement-API zu:

Schritte

  1. Melden Sie sich beim Tenant Manager an.

  2. Wählen Sie oben im Tenant Manager das Hilfesymbol aus und wählen Sie API Documentation aus.

API-Betrieb

Die Mandantenmanagement-API organisiert die verfügbaren API-Vorgänge in die folgenden Abschnitte:

  • Account — Betrieb auf dem aktuellen Mandantenkonto, einschließlich der Speicherung Informationen zur Nutzung.

  • Auth — Operationen zur Authentifizierung der Benutzersitzung.

    Die Mandantenmanagement-API unterstützt das Authentifizierungsschema für das Inhabertoken. Für eine Mandantenanmeldung geben Sie einen Benutzernamen, ein Passwort und eine Buchhaltungs-ID im JSON-Körper der Authentifizierungsanforderung (d. h. POST /api/v3/authorize). Wenn der Benutzer erfolgreich authentifiziert wurde, wird ein Sicherheitstoken zurückgegeben. Dieses Token muss im Header der nachfolgenden API-Anforderungen ("Authorization: Bearer Token") bereitgestellt werden.

    Informationen zur Verbesserung der Authentifizierungssicherheit finden Sie unter Schützen Sie sich vor Cross-Site Request Forgery.

    Hinweis Wenn Single Sign-On (SSO) für das StorageGRID-System aktiviert ist, müssen Sie zur Authentifizierung verschiedene Schritte durchführen. Siehe Anweisungen zur Verwendung der Grid Management API.

  • Config — Operationen bezogen auf die Produktversion und Versionen der Mandantenmanagement-API. Sie können die Produktversion und die Hauptversionen der von dieser Version unterstützten API auflisten.

  • Container — Betrieb auf S3 Buckets oder Swift Containern, wie folgt:

    S3

    • Bucket erstellen (mit und ohne S3-Objektsperre)

    • Ändern der Bucket-Standardaufbewahrung (für Buckets, für die S3-Objektsperre aktiviert ist)

    • Legen Sie die Consistency Control für Vorgänge fest, die an Objekten ausgeführt werden

    • Erstellen, Aktualisieren und Löschen der CORS-Konfiguration eines Buckets

    • Aktiviert und deaktiviert Updates der letzten Zugriffszeit für Objekte

    • Managen der Konfigurationseinstellungen für Plattform-Services, einschließlich CloudMirror-Replizierung, Benachrichtigungen und Suchintegration (Metadatenbenachrichtigung)

    • Leere Buckets löschen

    Swift: Legen Sie die für Container verwendete Konsistenzstufe fest

  • Deaktivierte Funktionen — Funktionen zum Anzeigen von Funktionen, die möglicherweise deaktiviert wurden.

  • Endpunkte — Operationen zur Verwaltung eines Endpunkts. Endpunkte ermöglichen es einem S3-Bucket, einen externen Service für die Replizierung, Benachrichtigungen oder Suchintegration von StorageGRID CloudMirror zu verwenden.

  • Groups — Operations zur Verwaltung lokaler Mandantengruppen und zum Abrufen von verbundenen Mandantengruppen aus einer externen Identitätsquelle.

  • Identity-Source — Operationen, um eine externe Identitätsquelle zu konfigurieren und föderierte Gruppen- und Benutzerinformationen manuell zu synchronisieren.

  • Regionen — Operationen zur Bestimmung, welche Regionen für das StorageGRID-System konfiguriert wurden.

  • s3 — Betrieb zum Managen von S3-Zugriffsschlüsseln für Mandantenbenutzer.

  • s3-Object-Lock — Operationen auf globalen S3 Object Lock Einstellungen, verwendet, um die Einhaltung gesetzlicher Vorschriften zu unterstützen.

  • Benutzer — Operationen zum Anzeigen und Verwalten von Mandantenbenutzern.

Betriebsdetails

Wenn Sie die einzelnen API-Operationen erweitern, können Sie die HTTP-Aktion, die Endpunkt-URL, eine Liste aller erforderlichen oder optionalen Parameter, ein Beispiel des Anforderungskörpers (falls erforderlich) und die möglichen Antworten sehen.

Beispiel für DIE FUNKTION GET Groups in Swagger API

API-Anforderungen ausgeben

Wichtig Alle API-Operationen, die Sie mit der API Docs Webseite durchführen, sind Live-Operationen. Achten Sie darauf, dass Konfigurationsdaten oder andere Daten nicht versehentlich erstellt, aktualisiert oder gelöscht werden.
Schritte

  1. Wählen Sie die HTTP-Aktion aus, um die Anfragedetails anzuzeigen.

  2. Stellen Sie fest, ob für die Anforderung zusätzliche Parameter erforderlich sind, z. B. eine Gruppe oder eine Benutzer-ID. Dann erhalten Sie diese Werte. Sie müssen möglicherweise zuerst eine andere API-Anfrage stellen, um die Informationen zu erhalten, die Sie benötigen.

  3. Bestimmen Sie, ob Sie den Text für die Beispielanforderung ändern müssen. In diesem Fall können Sie Modell wählen, um die Anforderungen für jedes Feld zu erfahren.

  4. Wählen Sie Probieren Sie es aus.

  5. Geben Sie alle erforderlichen Parameter ein, oder ändern Sie den Anforderungskörper nach Bedarf.

  6. Wählen Sie Ausführen.

  7. Überprüfen Sie den Antwortcode, um festzustellen, ob die Anfrage erfolgreich war.