Group API

Übersicht

Die Group API dient zur Verwaltung von Gruppen in Fess. Sie können Gruppen erstellen, aktualisieren und löschen.

Basis-URL

/api/admin/group

Endpunktliste

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

Gruppenliste abrufen

Request

GET /api/admin/group/settings

Parameter

Parameter Typ Erforderlich Beschreibung
size Integer Nein Anzahl der Einträge pro Seite (Standard: 25)
page Integer Nein Seitennummer (beginnt bei 1, Standard: 1)
id String Nein Filtert anhand der exakten Übereinstimmung mit der angegebenen Gruppen-ID

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "group_id_1",
        "name": "Engineering",
        "attributes": {
          "gidNumber": "1000"
        },
        "versionNo": 1
      },
      {
        "id": "group_id_2",
        "name": "Sales",
        "attributes": {
          "gidNumber": "1001"
        },
        "versionNo": 1
      }
    ],
    "total": 5
  }
}

Gruppe abrufen

Request

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

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "group_id_1",
      "name": "Engineering",
      "attributes": {
        "gidNumber": "1000"
      },
      "versionNo": 1
    }
  }
}

Gruppe erstellen

Request

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

Request-Body

{
  "name": "Marketing",
  "attributes": {
    "gidNumber": "1002"
  }
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
name Ja Gruppenname (maximal 100 Zeichen)
attributes Nein Attribut-Map (enthält LDAP-Attribute wie gidNumber). Werte werden als Zeichenketten angegeben

Response

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

Gruppe aktualisieren

Request

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

Request-Body

{
  "id": "existing_group_id",
  "name": "Marketing Team",
  "attributes": {
    "gidNumber": "1002"
  },
  "versionNo": 1
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
id Ja Zu aktualisierende Gruppen-ID
name Ja Gruppenname (maximal 100 Zeichen)
attributes Nein Attribut-Map (enthält LDAP-Attribute wie gidNumber). Werte werden als Zeichenketten angegeben
versionNo Ja Versionsnummer für optimistisches Sperren. Geben Sie den Wert von versionNo an, der beim Abrufen der Gruppe ermittelt wurde

Response

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

Gruppe löschen

Request

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

Response

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

Verwendungsbeispiele

Neue Gruppe erstellen

curl -X POST "http://localhost:8080/api/admin/group/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Product Team",
       "attributes": {
         "gidNumber": "2000"
       }
     }'

Gruppenliste abrufen

curl -X GET "http://localhost:8080/api/admin/group/settings" \
     -H "Authorization: Bearer YOUR_TOKEN"

Referenzinformationen