Für Entwickler

Apps und Datenarten registrieren

Konfiguriere öffentliche PKCE-Clients, Rücksprungadressen, Sichtbarkeit und eigene Sync-Ressourcen.

Voraussetzungen und Grenzen#

Unter Meine Apps können Konten mit bestätigter E-Mail bis zu 20 eigene Apps anlegen. Selbst registrierte Apps sind öffentliche Browser-Clients mit Authorization Code, S256-PKCE und den Scopes openid profile sync. Sie erhalten kein Client-Secret.

Vertrauliche serverseitige Clients und spezielle Dienste benötigen eine Einrichtung durch den Betreiber. Es gibt keinen offenen Endpunkt für dynamische OIDC-Client-Registrierung.

Felder richtig ausfüllen#

Feld Bedeutung
Name und Beschreibung Erklären Nutzern, welche App die Anmeldung anfordert
App-Adresse Vollständige Adresse deiner selbst gehosteten App
Rücksprungadressen Eine bis fünf exakte Callback-URLs derselben Origin
Sichtbarkeit Privat oder per Link teilbar
Testmodus Beschränkt Anmeldung unabhängig von der Sichtbarkeit auf den Ersteller

Produktion verwendet HTTPS. Im Testmodus ist HTTP nur auf localhost, 127.0.0.1 oder ::1 erlaubt. App und Callbacks müssen Protokoll, Host und Port teilen. HTTPS auf einer anderen Domain ist damit keine passende Callback-Origin.

Callbacks brauchen einen konkreten Dateipfad. Wildcards, Query-Parameter, Fragmente, Zugangsdaten in URLs und Verzeichnispfade mit abschließendem Schrägstrich sind nicht zulässig. Die Account-Domain ist für eigene Apps reserviert.

App-ID und Client-ID#

Die zufällig vergebene App-ID bleibt unveränderlich. Sie bestimmt unter anderem den Ordner in ownCloud und den API-Pfad. Die OAuth-Client-ID verwendest du dagegen für Autorisierungs- und Tokenanfragen. Übernimm beide Werte aus der generierten öffentlichen Konfiguration.

Datenarten anlegen#

Eine App darf bis zu zehn Datenarten definieren. Jede hat einen technischen Schlüssel, einen sichtbaren Titel und eine Beschreibung. Der Schlüssel folgt diesem Muster:

[a-z][a-z0-9-]{0,39}

Geeignete Beispiele sind notes, projects und settings. Jede freigegebene Datenart entspricht einer JSON-Datei mit höchstens 512 KiB inklusive Umschlag. Neu angelegte oder erneut aktivierte Datenarten benötigen eine ausdrückliche Nutzerfreigabe.

Nach Änderungen an den Datenarten aktualisierst du die Konfiguration deiner App oder lädst die Vorlage erneut herunter. Die Registrierung veröffentlicht keine neuen Dateien auf deinem Webserver.

Änderungen, Deaktivieren und Löschen#

Änderungen an Callback- oder Zugriffsregeln sowie das Deaktivieren oder Löschen widerrufen bestehende Tokens, offene Codes, Zustimmungen und Sync-Freigaben. Nutzer müssen danach neu zustimmen.

Das Löschen einer Registrierung ist keine Löschung der Nutzerdateien. Nutzer können eigene Cloud-Dateien unter Apps & Zugriff weiterhin selbst verwalten. Ein öffentliches App-Verzeichnis, App-Hosting und eine Eigentumsübertragung sind derzeit nicht vorgesehen.

Markdown herunterladen