AccessToken API

Übersicht

Die AccessToken API dient zur Verwaltung von API-Zugriffstoken in Fess. Sie können Token erstellen, aktualisieren und löschen.

Basis-URL

/api/admin/accesstoken

Endpunktliste

Methode Pfad Beschreibung
GET/PUT /settings Access Token Liste abrufen
GET /setting/{id} Access Token abrufen
POST /setting Access Token erstellen
PUT /setting Access Token aktualisieren
DELETE /setting/{id} Access Token löschen

Access Token Liste abrufen

Request

GET /api/admin/accesstoken/settings
PUT /api/admin/accesstoken/settings

Parameter

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "token_id_1",
        "name": "API Token 1",
        "token": "abcd1234efgh5678",
        "parameterName": "token",
        "expiredTime": 1735689600000,
        "permissions": ["admin"]
      }
    ],
    "total": 5
  }
}

Access Token abrufen

Request

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

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "token_id_1",
      "name": "API Token 1",
      "token": "abcd1234efgh5678",
      "parameterName": "token",
      "expiredTime": 1735689600000,
      "permissions": ["admin"]
    }
  }
}

Access Token erstellen

Request

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

Request-Body

{
  "name": "Integration API Token",
  "parameterName": "token",
  "permissions": ["user"]
}

Feldbeschreibungen

Response

{
  "response": {
    "status": 0,
    "id": "new_token_id",
    "token": "generated_token_string",
    "created": true
  }
}

Access Token aktualisieren

Request

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

Request-Body

{
  "id": "existing_token_id",
  "name": "Updated API Token",
  "parameterName": "token",
  "expiredTime": 1767225600000,
  "permissions": ["user", "editor"],
  "versionNo": 1
}

Response

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

Access Token löschen

Request

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

Response

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

Verwendungsbeispiele

API-Token erstellen

curl -X POST "http://localhost:8080/api/admin/accesstoken/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "External App Token",
       "parameterName": "token",
       "permissions": ["guest"]
     }'

API-Aufruf mit Token

# Token als Parameter verwenden
curl "http://localhost:8080/json/?q=test&token=your_token_here"

# Token im Authorization-Header verwenden
curl "http://localhost:8080/json/?q=test" \
     -H "Authorization: Bearer your_token_here"

Referenzinformationen