ownCloud Administrator Handbuch

Benutzereinrichtungs API¶

Die Benutzereinrichtungs API-Anwendung ermöglicht es das eine Reihe von APIs, die externe Systeme verwenden können, Benutzerattribute erstellen, bearbeiten, löschen und Abfrage können, Gruppen abfragen, erstellen und entfernen können sowie die eingestellt Quote dazu abfragen können und die Gesamtspeicherkapazität, die in ownCloud dazu verwendet wird, ermitteln. Gruppen Admin-Benutzer können auch abfragen in ownCloud durchführen, das gleiche gilt für für Gruppenadmin, die diese verwalten. Die API ermöglicht es auch einen Admin für aktive ownCloud Anwendungen, Anwendungs abfragen mit den Info dazu, durchzufrühen und diese zu aktivieren oder um eine App aus der Ferne zu deaktivieren. HTTP Anfragen können über ein Grund Auth-Header verwendet werden, um eine der Funktionen auszuführen die oben aufgeführt sind. Das Benutzereinrichtungs API App ist standardmäßig aktiviert.

Die Basis-URL für alle Anrufe auf die Freigabe APIT ist owncloud_base_url/ocs/v1.php/cloud.

Befehlssatz¶

Benutzer / hinzufügen¶

So Erstellen Sie einen neuen Benutzer auf dem ownCloud-Server. Die Authentifizierung wird durch das Senden eines grundlegenden HTTP Authentication Header getan.

Syntax: ocs/v1.php/cloud/users

  • HTTP method: POST
  • POST argument: userid - Zeichenfolge, die den erforderlichen Benutzernamen für den neuen Benutzer enthält
  • POST argument: password - Zeichenfolge, die das erforderliche Passwort für den neuen Benutzer enthält

Status Codes:

  • 100 - erfolgreich
  • 101 - ungültige Eingangsdaten
  • 102 - Benutzername existiert bereits
  • 103 - ein unbekannter Fehler ist aufgetreten, während des Hinzufügens des Benutzers

Beispiel¶

  • POST http://admin:secret@example.com/ocs/v1.php/cloud/users -d userid="Frank" -d password="frankspassword"
  • Erstellen eines Benutzers Frank mit dem Password frankspassword

XML Ausgabe¶

<?xml version="1.0"?>
 <ocs>
  <meta>
   <statuscode>100</statuscode>
   <status>ok</status>
  </meta>
  <data>
   <email>frank@example.org</email>
   <quota>0</quota>
   <enabled>true</enabled>
  </data>
 </ocs>

Benutzer / erhalten der Benutzer¶

Ruft eine Liste von Benutzern vom Cloud-Server ab. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Headers.

Syntax: ocs/v1.php/cloud/users

  • HTTP method: GET
  • url arguments: search - String, optionaler Suchbegriff
  • url arguments: limit - int, optionaler Grenzwert
  • url arguments: offset - int, optionaler Offset-Wert

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • GET http://admin:secret@example.com/ocs/v1.php/cloud/users?search=Frank
  • Liefert eine Liste der Benutzer, die der Suchzeichenfolge entsprechen.

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <users>
      <element>Frank</element>
     </users>
  </data>
</ocs>

Benutzer / erhalten eines Benutzers¶

Ruft Informationen über einen einzelnen Benutzer ab. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}

  • HTTP method: GET

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank
  • Gibt Informationen über den Benutzer Frank aus.

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <email>frank@example.org</email>
    <quota>0</quota>
    <enabled>true</enabled>
  </data>
</ocs>

Benutzer / bearbeiten eines Benutzers¶

Bearbeiten der Attribute eines Benutzer. Benutzer können E-Mail, Displayname und Kennwort bearbeiten; Administratoren können auch den Wert der Quote Wert bearbeiten. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}

  • HTTP method: PUT
  • PUT argument: key, das Feld zum bearbeiten/ändern von (E-Mail, Quote, Display, Passwort)
  • PUT argument: value, der neue Wert für das Feld

Status Codes:

  • 100 - erfolgreich
  • 101 - Benutzer nicht gefunden
  • 102 - ungültige Eingangsdaten

Beispiel¶

  • PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d key="email", value="franksnewemail@example.org"
  • Aktualisiert die E-Mail-Adresse für den Benutzer Frank

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Benutzer / löschen eines Benutzers¶

Löscht einen Benutzer auf dem Cloud-Server. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}

  • HTTP method: DELETE

Statuscodes:

  • 100 - erfolgreich
  • 101 - gescheitert

Beispiel¶

  • DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank
  • Löscht den Nutzer Frank

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Benutzer / Gruppen des Bentuzers¶

Ruft eine Liste der Gruppen des angegebenen Benutzer ab, in der dieser Mitglied ist. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}/groups

  • HTTP method: GET

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups
  • Ruft eine Liste von Gruppen ab, in denen Frank Mitglied ist

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <groups>
      <element>admin</element>
      <element>group1</element>
    </groups>
  </data>
</ocs>

Benutzer / Benutzer zur Gruppe hinzufügen¶

Fügt den angegebenen Benutzer der angegebenen Gruppe hinzu. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}/groups

  • HTTP method: POST
  • POST argument: groupid, string - die Gruppe, zu der der Benutzer hinzugefügt werden soll

Status Codes:

  • 100 - erfolgreich
  • 101 - keine Gruppe angegeben
  • 102 - Gruppe nicht vorhanden
  • 103 - Benutzer existiert nicht
  • 104 - keine ausreichenden Berechtigungen
  • 105 - Benutzer konnte nicht zu der Gruppe hinzuhgefügt werden

Beispiel¶

  • POST http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d groupid="newgroup"
  • Fügt den Benutzer Frank der Gruppe newgroup hinzu

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Benutzer / Benutzer aus Gruppe entfernen¶

Entfernt den angegebenen Benutzer aus der angegebenen Gruppe. Die Authentifizierung erfolgt durch des Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}/groups

  • HTTP method: DELETE
  • POST argument: groupid, string - die Gruppe, aus der der Benutzer entfernt werden soll

Status Codes:

  • 100 - erfolgreich
  • 101 - keine Gruppe angegeben
  • 102 - Gruppe tut nicht existieren
  • 103 - Benutzer existiert nicht
  • 104 - keine ausreichenden Berechtigungen
  • 105 - konnte den Benutzer nicht aus der Gruppe entfernen

Beispiel¶

  • DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d groupid="newgroup"
  • Entfernt den Benutzer Frank aus der Gruppe newgroup

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Benutzer / erstellen eines Subadmin¶

Macht ein Benutzer zum Subadmin einer Gruppe. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}/subadmins

  • HTTP method: POST
  • POST argument: groupid, String - Die Gruppe, zu der der Benutzer Subadmin werden soll

Status Codes:

  • 100 - erfolgreich
  • 101 - Benutzer existiert nicht
  • 102 - Gruppe ist nicht vorhanden
  • 103 - unbekannter Fehler

Beispiel¶

  • POST http://admin:secret@myowncloud.org/ocs/v1.php/cloud/users/Frank/subadmin -d groupid="group"
  • Macht den Benutzer Frank zum Subadmin in der group Gruppe

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Benutzer / entfernen eines Subadmin¶

Entfernt die Subadmin Rechte des angegebenen Benutzer für die entsprechende Gruppe . Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}/subadmin

  • HTTP method: DELETE
  • DELETE argument: groupid, string - die Gruppe, aus der dieSubadmin Rechte des Benutzers entfernen werden sollen

Status Codes:

  • 100 - erfolgreich
  • 101 - Benutzer existiert nicht
  • 102 - Benutzer ist kein Subadmin der Gruppe / Gruppe nicht vorhanden
  • 103 - unbekannter Fehler

Beispiel¶

  • DELETE http://admin:secret@myowncloud.org/ocs/v1.php/cloud/users/Frank/subadmin -d groupid="oldgroup"
  • Entfernt Frank's Subadmin Rechte aus der oldgroup Gruppe

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Benutzer / alle Subadmingrupen des Benutzers¶

Gibt die Gruppen aus, in denen der Benutzer ein Subadmin ist. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/users/{userid}/subadmins

  • HTTP method: GET

Status codes:

  • 100 - erfolgreich
  • 101 - Benutzer existiert nicht
  • 102 - unbekannter Fehler

Beispiel¶

  • GET http://admin:secret@myowncloud.org/ocs/v1.php/cloud/users/Frank/subadmin
  • Gibt die Gruppen aus, in denen Frank Subadmin ist

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
      <status>ok</status>
      <statuscode>100</statuscode>
    <message/>
  </meta>
  <data>
    <element>testgroup</element>
  </data>
</ocs>

Gruppen / alle Gruppen¶

Ruft eine Liste der Gruppen vom Cloud-Server ab. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/groups

  • HTTP method: GET
  • url arguments: search - string, optionaler Suchbegriff
  • url arguments: limit - int, optionaler Grenzwert
  • url arguments: offset - int, optionaler Offset-Wert

Status codes:

  • 100 - erfolgreich

Beispiel¶

  • GET http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm
  • Liefert eine Liste der Gruppen, die der Suchzeichenfolge entsprechen.

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <groups>
      <element>admin</element>
    </groups>
  </data>
</ocs>

Gruppen / Gruppe hinzufügen¶

Fügt eine neue Gruppe hinzu. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/groups

  • HTTP method: POST
  • POST argument: groupid, string - der neue Name der Gruppe

Status codes:

  • 100 - erfolgreich
  • 101 - ungültige Eingangsdaten
  • 102 - Gruppe ist bereits vorhanden
  • 103 - die Gruppe konnte nicht hinzugfügt werden

Beispiel¶

  • POST http://admin:secret@example.com/ocs/v1.php/cloud/groups -d groupid="newgroup"
  • Fügt eine neue Gruppe mit dem Namen newgroup hinzu

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Gruppen / diese Gruppe¶

Ruft eine Liste der Mitglieder dieser Gruppe ab. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/groups/{groupid}

  • HTTP method: GET

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • POST http://admin:secret@example.com/ocs/v1.php/cloud/groups/admin
  • Gibt eine Liste von Benutzern in der admin Gruppe aus

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <users>
      <element>Frank</element>
    </users>
  </data>
</ocs>

Gruppen / aller Subadmins dieser Gruppe¶

Gibt die Subadmins der Gruppe aus. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/groups/{groupid}/subadmins

  • HTTP method: GET

Status Codes:

  • 100 - erfolgreich
  • 101 - Gruppe nicht vorhanden
  • 102 - unbekannter Fehler

Beispiel¶

  • GET http://admin:secret@myowncloud.org/ocs/v1.php/cloud/groups/mygroup/subadmins
  • Gibt die Subadmins der Gruppe: mygroup aus

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <status>ok</status>
    <statuscode>100</statuscode>
    <message/>
  </meta>
  <data>
    <element>Tom</element>
  </data>
</ocs>

Gruppe / Gruppe löschen¶

Entfernt eine Gruppe. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/groups/{groupid}

  • HTTP method: DELETE

Status Codes:

  • 100 - erfolgreich
  • 101 - Gruppe nicht vorhanden
  • 102 - konnte die Gruppe nicht löschen

Beispiel¶

  • DELETE http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup
  • Löschen der Gruppe mygroup

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data/>
</ocs>

Apps / diese App¶

Gibt eine Liste der Apps aus die auf dem Cloud-Server installiert sind. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/apps/

  • HTTP method: GET
  • url argument: filter, string - optional (aktiviert oder deaktiviert)

Status Codes:

  • 100 - erfolgreich
  • 101 - ungültige Eingangsdaten

Beispiel¶

  • GET http://admin:secret@example.com/ocs/v1.php/cloud/apps?filter=enabled
  • Ruft die App auf und aktiviert sie

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <apps>
      <element>files</element>
      <element>provisioning_api</element>
    </apps>
  </data>
</ocs>

Apps / Info der App¶

Gibt Informationen zu einer bestimmten Anwendung aus. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/apps/{appid}

  • HTTP method: GET

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • GET http://admin:secret@example.com/ocs/v1.php/cloud/apps/files
  • Gibt die App-Info für die Datei App aus

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <info/>
    <remote>
      <files>appinfo/remote.php</files>
      <webdav>appinfo/remote.php</webdav>
      <filesync>appinfo/filesync.php</filesync>
    </remote>
    <public/>
    <id>files</id>
    <name>Files</name>
    <description>File Management</description>
    <licence>AGPL</licence>
    <author>Robin Appelman</author>
    <require>4.9</require>
    <shipped>true</shipped>
    <standalone></standalone>
    <default_enable></default_enable>
    <types>
      <element>filesystem</element>
    </types>
  </data>
</ocs>

Apps / aktivieren¶

Aktivieren Sie eine App. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/apps/{appid}

  • HTTP method: POST

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • POST http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor
  • Aktivieren der files_texteditor App

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
</ocs>

Apps / dekaktivieren¶

Deaktiviert die angegebene App. Die Authentifizierung erfolgt durch das Senden eines HTTP Basic-Authorization-Header.

Syntax: ocs/v1.php/cloud/apps/{appid}

  • HTTP method: DELETE

Status Codes:

  • 100 - erfolgreich

Beispiel¶

  • DELETE http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor
  • Deaktivieren der files_texteditor App

XML Ausgabe¶

<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
</ocs>