Management-Clients auflisten

GET /v1/management-clients · Berechtigung management-clients:read

Gibt die Management-Client-Datensätze der Umgebung seitenweise per Cursor zurück, sortiert nach application_id (standardmäßig absteigend). Ein Datensatz gehört zu einer Anwendung vom Typ management und enthält deren Berechtigungsobergrenze und Liste erlaubter IP-Adressen für die Management-API. Die Signaturschlüssel des Clients sind nicht Teil dieser Ressource: Verwalten Sie sie über /v1/applications/{application_id}/credentials. Nur ein API-Schlüssel kann diesen Endpunkt aufrufen; die Umgebung ergibt sich aus dem Schlüssel.

Anfrage

Parameter Typ Erforderlich Beschreibung
limit Integer nein 1–100, Standard 20.
after String nein Cursor aus list_metadata.after. Schließt before aus.
before String nein Cursor aus list_metadata.before.
order String nein asc oder desc (Standard). Ein Cursor ist nur mit derselben order gültig.

Antwort

200 OK

{
  "data": [
    {
      "application_id": "app_01h455vb4pex5vsknk084sn02q",
      "permissions": ["users:read", "users:write"],
      "allowed_cidrs": ["203.0.113.0/24"]
    }
  ],
  "list_metadata": { "before": null, "after": null }
}

Ein null-Cursor bedeutet, dass in dieser Richtung keine weiteren Datensätze vorhanden sind. Eine Gesamtanzahl wird nicht zurückgegeben. Das Löschen einer Anwendung entfernt deren Datensatz; ein Datensatz, dessen Anwendung nicht mehr existiert, wird nie aufgelistet und entfernt, sobald eine Seite ihn erreicht. Daher kann eine Seite weniger Datensätze als limit enthalten, während after noch gesetzt ist. Folgen Sie dem Cursor weiter.

Fehler

HTTP code Wann
400 invalid_cursor Der Cursor ist fehlerhaft, manipuliert oder wurde für eine andere Umgebung oder eine andere order ausgestellt.
403 insufficient_permissions Der Berechtigungsnachweis hat nicht management-clients:read, oder es ist kein API-Schlüssel.
422 validation_failed Ein Abfrageparameter ist ungültig.

Beispiel

curl "https://api.eu.keenauth.com/v1/management-clients?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI: keenauth management-clients list --limit 20