API-Referenz

Vollständige Referenzdokumentation für die Nomid MDM External API. Finden Sie detaillierte Informationen zu Endpunkten, Parametern und Antwortformaten.

Basis-URL

https://api.nomid.tech/emm/api/v1

Dokumentationsabschnitte

Authentifizierung

Erfahren Sie, wie Sie Ihre API-Anfragen mit API-Schlüsseln authentifizieren.

Assets

Endpunkte zum Auflisten, Filtern und Abrufen von Asset-Informationen.

Richtlinien

Endpunkte für den Zugriff auf Richtliniendaten und Gerätezuweisungen.

Fehler

Fehlerantworten und Statuscodes verstehen.

BI-Integration

Abgeflachte Datenexporte für Business-Intelligence-Tools.

Gerätebefehle-API

Senden Sie mit einem REST-Aufruf einen Befehl an jeweils ein Gerät – von Sperren, Neustart und Nachrichten bis hin zu destruktiven Befehlen wie dem Löschen.

Richtlinieneinstellungen, Apps, WLAN-Netzwerke und mehr ändern, eine Richtlinie von Grund auf neu oder als Kopie erstellen oder eine Richtlinie zurücksetzen – mit einem Überprüfungsschritt, bevor Änderungen angewendet werden.

Bereitstellungs-QR-Codes-API

Erstellen Sie einen QR-Code, der ein neues Android-Gerät mit einer Richtlinie registriert, mit einem eigenen Registrierungstoken, das für 24 Stunden gültig ist.

Alle Endpunkte

Methode	Endpunkt	Beschreibung
GET	/assets	Alle Assets mit Paginierung und Filterung auflisten
GET	/assets/count	Gesamtzahl der Assets abrufen
GET	/assets/{id}	Details zu einem bestimmten Asset abrufen
GET	/policies	Alle Richtlinien auflisten
GET	/policies/{pathName}	Details zu einer bestimmten Richtlinie abrufen
GET	/assets/summary	Aggregierte Flottenzahlen abrufen: Gesamtzahlen, eine Statusaufschlüsselung und eine Zusammenfassung des Sicherheitsstatus
GET	/assets/{assetId}/commands	Die neuesten an ein Gerät gesendeten Befehle auflisten
POST	/assets/{assetId}/commands/lock	Den Gerätebildschirm sofort sperren. Nur Geräte mit Android Management. Kein Request-Body.
POST	/assets/{assetId}/commands/lost-mode	Das Gerät sperren und eine Nachricht mit optionalen Kontaktdaten auf dessen Sperrbildschirm anzeigen. Nur Geräte mit Android Management.
POST	/assets/{assetId}/commands/found	Modus für verlorene Geräte beenden. Wenn sich das Gerät nicht im Modus für verlorene Geräte befand, geschieht nichts und es wird kein Fehler zurückgegeben. Nur Geräte mit Android Management. Kein Request-Body.
POST	/assets/{assetId}/commands/message	Eine Nur-Text-Push-Benachrichtigung auf dem Gerät anzeigen.
POST	/assets/{assetId}/commands/status-report	Fordern Sie das Gerät auf, jetzt einen aktuellen Statusbericht zu senden. Der Bericht trifft später ein: Lesen Sie ihn mit GET /assets/ASSET_ID aus. Kein Request-Body.
POST	/assets/{assetId}/commands/location-update	Fordern Sie das Gerät auf, seinen aktuellen Standort jetzt zu melden. Der Standort trifft später ein: Lesen Sie ihn mit GET /assets/ASSET_ID aus. Kein Request-Body.
POST	/assets/{assetId}/commands/sync-policy	Senden Sie dem Gerät seine aktuelle Richtlinie erneut. Nur für Geräte, die vom Nomid-Agenten (AOSP) verwaltet werden: Android Management-Geräte erhalten Richtlinienänderungen automatisch und antworten mit 409. Kein Request-Body.
POST	/assets/{assetId}/commands/reboot	Starten Sie das Gerät jetzt neu. Die Person, die es gerade verwendet, wird unterbrochen und ungespeicherte Arbeit kann verloren gehen. Kein Request-Body.
POST	/assets/{assetId}/commands/shutdown	Schalten Sie das Gerät jetzt aus. Es kann nicht aus der Ferne wieder eingeschaltet werden. Nur für Geräte, die vom Nomid-Agenten (AOSP) verwaltet werden. Kein Request-Body.
POST	/assets/{assetId}/commands/launch-app	Öffnen Sie eine installierte App auf dem Gerät anhand des Paketnamens. Nur für Geräte, die vom Nomid-Agenten (AOSP) verwaltet werden.
POST	/assets/{assetId}/commands/clear-app-data	Löschen Sie alle Daten der angegebenen Apps (Konten, Einstellungen und Dateien), als wären sie gerade erst installiert worden. Dies kann nicht rückgängig gemacht werden. Nur für Android Management-Geräte.
POST	/assets/{assetId}/commands/change-policy	Verschieben Sie das Gerät in eine andere Richtlinie des Unternehmens. Das Gerät wendet die Apps, Einschränkungen und Einstellungen der neuen Richtlinie an, und alles, was nur in der aktuellen Richtlinie enthalten war, wird entfernt. Erfordert außerdem POLICIES_READ.
POST	/assets/{assetId}/commands/wipe	Entfernen Sie das Gerät aus der Verwaltung und löschen Sie dessen verwaltete Daten. Ein unternehmenseigenes Gerät wird auf die Werkseinstellungen zurückgesetzt: Jede App und alle Daten darauf werden gelöscht. Bei einem Gerät in Privatbesitz mit einem Arbeitsprofil werden nur das Arbeitsprofil und dessen Apps und Daten entfernt; private Apps und Daten bleiben erhalten. Nicht umkehrbar. Kein Request-Body.
POST	/assets/{assetId}/commands/reset-screen-lock	Entfernen Sie die Bildschirmsperre des Geräts (PIN, Muster oder Passwort), sodass es ohne Sperre entsperrt werden kann. Nur für Android Management-Geräte. Kein Request-Body.
POST	/assets/{assetId}/commands/change-screen-lock-password	Legen Sie ein neues Passwort für die Bildschirmsperre fest. Das Gerät sperrt sich und kann nur mit dem neuen Passwort entsperrt werden. Nur für Android Management-Geräte.
POST	/assets/{assetId}/commands/relinquish-ownership	Geben Sie ein unternehmenseigenes Gerät für seinen Benutzer frei. Das Arbeitsprofil und dessen Daten werden entfernt und das Gerät wird nicht mehr verwaltet. Nicht umkehrbar. Kein Request-Body.
GET	/policies/{policyId}/settings	Die bearbeitbaren Einstellungen der Richtlinie, jeweils mit aktuellem Wert, zulässigen Werten, Gruppe und der Angabe, ob eine Änderung erhebliche Auswirkungen hat (high impact). Gibt außerdem die Richtlinienversion, deviceCount, ob die Richtlinie bearbeitbar ist, sowie ihre Apps zurück, jeweils mit packageName, name, source, installType und managedByNomid, was für die Apps true ist, die hier nicht geändert werden können.
GET	/policies/{policyId}/document	Die vollständige Konfiguration der Richtlinie als JSON in value oder nur der Teil unter path, einem JSON-Pointer wie /openNetworkConfigurations. Eine App wird über ihren Paketnamen adressiert, wie etwa /apps/com.example.app. Geheimnisse (Secrets) werden als Markierung zurückgegeben, ein Objekt mit auf true gesetztem redacted, ebenso wie jeder Wert der verwalteten Konfiguration einer App. Ohne path werden Apps mit packageName, name, source, installType und managedConfigurationKeys zusammengefasst. Gibt außerdem policyId, displayName, version, deviceCount, editable und lockedFields zurück, die Felder, die der edits-Endpunkt ablehnt, jeweils mit Begründung. Ein Teil mit mehr als 30000 Zeichen gibt fieldSizes anstelle von value zurück: Lesen Sie einen spezifischeren Pfad. Gibt 422 zurück, wenn path eine App benennt, die in der Richtlinie nicht vorhanden ist.
GET	/policies/{policyId}/revisions	Die gespeicherten Revisionen der Richtlinie, die neuesten zuerst, mit Angabe darüber, wann und von wem sie jeweils gespeichert wurden. limit ist optional, von 1 bis 100, Standardwert 20.
GET	/policy-proposals/{proposalId}	Ein von diesem Schlüssel erstellter Vorschlag mit seiner Änderungsliste und seinem Status: PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED oder EXPIRED.
POST	/policies/{policyId}/changes	Schlagen Sie Einstellungsänderungen für eine bestehende Richtlinie vor. Gibt 201 mit dem Vorschlag zurück.
POST	/policies/{policyId}/app-changes	Vorschlagen, Apps zu einer bestehenden Richtlinie hinzuzufügen, sie zu entfernen oder ihre Installationsart zu ändern. Gibt 201 mit dem Vorschlag zurück.
POST	/policies/{policyId}/edits	Änderungen an beliebigen bearbeitbaren Teilen einer bestehenden Richtlinie als JSON-Pointer-Edits ihres Dokuments vorschlagen. Gibt 201 mit dem Vorschlag zurück.
POST	/policies	Eine neue Richtlinie mit optionalen Einstellungsänderungen vorschlagen. Mit fromPolicyId ist sie eine Kopie dieser Richtlinie und ohne Änderungen ein Duplikat. Ohne fromPolicyId startet sie mit den Standardwerten von Nomid. Gibt 201 mit dem Vorschlag zurück.
POST	/policies/{policyId}/rollbacks	Schlagen Sie vor, die Richtlinie auf eine frühere Revision zurückzusetzen. Gibt 201 mit dem Vorschlag zurück.
POST	/policy-proposals/{proposalId}/apply	Wenden Sie einen ausstehenden Vorschlag an. Gibt 200 mit dem Vorschlag und dessen Ergebnis zurück: policyId, displayName, version und einen Portallink.
POST	/policies/{policyId}/provisioning-qr-codes	Erstellen Sie einen Bereitstellungs-QR-Code für eine Richtlinie mit einem neuen Registrierungstoken

Inhaltstypen

Alle Anfragen und Antworten verwenden das JSON-Format. Setzen Sie den Content-Type-Header entsprechend.

Content-Type: application/json