Citrix Endpoint Management

REST APIs

Mit der Endpoint Management-REST-API haben Sie folgende Möglichkeiten:

  • Aufrufen von Diensten, die über die Endpoint Management-Konsole verfügbar gemacht werden
  • Aufrufen von REST-Diensten über einen beliebigen REST-Client

Die API erfordert zum Aufrufen der Dienste keine Anmeldung an der Endpoint Management-Konsole.

Eine umfassende, aktuelle Liste der verfügbaren APIs finden Sie in der PDF-Datei Öffentliche API für REST-Dienste.

Erforderliche Berechtigungen für den Zugriff auf die REST API

Für den Zugriff auf die REST API ist eine der folgenden Berechtigungen erforderlich:

  • Citrix Cloud-Administrator
  • Zugriffsberechtigung für öffentliche APIs, die bei der Konfiguration des rollenbasierten Zugriffs festgelegt wird Weitere Informationen finden Sie unter Konfigurieren von Rollen mit RBAC.
  • Superuser-Benutzerberechtigung

Um mit dem Citrix Cloud-Konto auf die REST-API zuzugreifen, generieren Sie die API-Schlüssel:

  1. Klicken Sie im Menü “Citrix Cloud” auf Identitäts- und Zugriffsverwaltung.
  2. Wählen Sie API-Zugriff > Sichere Clients.
  3. Geben Sie einen Namen für den sicheren Client ein und klicken Sie auf Client erstellen.

Citrix Cloud erstellt dann die Client-ID und den geheimen Clientschlüssel für den Client. Laden Sie eine Kopie der Informationen herunter und speichern Sie sie offline an einem sicheren Ort. Citrix Cloud speichert diese eindeutigen Bezeichner nicht, nachdem Sie das Dialogfeld geschlossen haben.

Aufrufen von REST-API-Diensten

Sie können REST-API-Dienste über den REST-Client oder cURL-Befehle aufrufen. Die folgenden Beispiele verwenden den Advanced REST-Client für Chrome.

Hinweis:

Ändern Sie für die folgenden Beispiele den Hostnamen und die Portnummer gemäß Ihrer Umgebung.

Anmeldung

Das hier gezeigte Beispiel behandelt die Anmeldung mit einem lokalen Benutzerkonto. Um sich mit Cloud-Anmeldeinformationen anzumelden, lesen Sie die zuvor erwähnte PDF-Datei.

URL: https://<host-name>:<port-number>/xenmobile/api/v1/authentication/login

Anforderung: { "login":"administrator", "password":"password" }

Methodentyp: POST

Inhaltstyp: application/json

Bildschirm mit Login Payload, Request headers und Response headers

Verwandte Informationen

REST APIs