User API

Übersicht

Die User API dient zur Verwaltung von Benutzerkonten in Fess. Sie können Benutzer erstellen, aktualisieren, löschen und Berechtigungen konfigurieren.

Basis-URL

/api/admin/user

Endpunktliste

Methode Pfad Beschreibung
GET/PUT /settings Benutzerliste abrufen
GET /setting/{id} Benutzer abrufen
POST /setting Benutzer erstellen
PUT /setting Benutzer aktualisieren
DELETE /setting/{id} Benutzer löschen

Benutzerliste abrufen

Request

GET /api/admin/user/settings
PUT /api/admin/user/settings

Parameter

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "user_id_1",
        "name": "admin",
        "surname": "Administrator",
        "givenName": "System",
        "mail": "admin@example.com",
        "roles": ["admin"],
        "groups": []
      }
    ],
    "total": 10
  }
}

Benutzer abrufen

Request

GET /api/admin/user/setting/{id}

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "user_id_1",
      "name": "admin",
      "surname": "Administrator",
      "givenName": "System",
      "mail": "admin@example.com",
      "telephoneNumber": "",
      "homePhone": "",
      "homePostalAddress": "",
      "labeledUri": "",
      "roomNumber": "",
      "description": "",
      "title": "",
      "pager": "",
      "street": "",
      "postalCode": "",
      "physicalDeliveryOfficeName": "",
      "destinationIndicator": "",
      "internationaliSDNNumber": "",
      "state": "",
      "employeeNumber": "",
      "facsimileTelephoneNumber": "",
      "postOfficeBox": "",
      "initials": "",
      "carLicense": "",
      "mobile": "",
      "postalAddress": "",
      "city": "",
      "teletexTerminalIdentifier": "",
      "x121Address": "",
      "businessCategory": "",
      "registeredAddress": "",
      "displayName": "",
      "preferredLanguage": "",
      "departmentNumber": "",
      "uidNumber": "",
      "gidNumber": "",
      "homeDirectory": "",
      "roles": ["admin"],
      "groups": []
    }
  }
}

Benutzer erstellen

Request

POST /api/admin/user/setting
Content-Type: application/json

Request-Body

{
  "name": "testuser",
  "password": "securepassword",
  "surname": "Test",
  "givenName": "User",
  "mail": "testuser@example.com",
  "roles": ["user"],
  "groups": ["group_id_1"]
}

Feldbeschreibungen

Response

{
  "response": {
    "status": 0,
    "id": "new_user_id",
    "created": true
  }
}

Benutzer aktualisieren

Request

PUT /api/admin/user/setting
Content-Type: application/json

Request-Body

{
  "id": "existing_user_id",
  "name": "testuser",
  "password": "newpassword",
  "surname": "Test",
  "givenName": "User Updated",
  "mail": "testuser.updated@example.com",
  "roles": ["user", "editor"],
  "groups": ["group_id_1", "group_id_2"],
  "versionNo": 1
}

Response

{
  "response": {
    "status": 0,
    "id": "existing_user_id",
    "created": false
  }
}

Benutzer löschen

Request

DELETE /api/admin/user/setting/{id}

Response

{
  "response": {
    "status": 0,
    "id": "deleted_user_id",
    "created": false
  }
}

Verwendungsbeispiele

Neuen Benutzer erstellen

curl -X POST "http://localhost:8080/api/admin/user/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "john.doe",
       "password": "SecureP@ss123",
       "surname": "Doe",
       "givenName": "John",
       "mail": "john.doe@example.com",
       "roles": ["user"],
       "groups": []
     }'

Benutzerrollen ändern

curl -X PUT "http://localhost:8080/api/admin/user/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "id": "user_id_123",
       "name": "john.doe",
       "roles": ["user", "editor", "admin"],
       "versionNo": 1
     }'

Referenzinformationen