Policies Endpoints

Die Policies API bietet Endpoints zur Verwaltung von Zugriffsrichtlinien, die erwartete Zugriffsmuster und Governance-Regeln definieren.

Basis-URL

Alle Endpoints sind relativ zu /api/v1/policies.

---

Richtlinien auflisten

Ruft eine paginierte Liste von Richtlinien ab.

GET /api/v1/policies

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Query-Parameter

Parameter	Typ	Beschreibung
search	string	Nach Richtlinienname suchen
type	string	Nach Richtlinientyp filtern
status	string	Nach Status filtern (active, inactive, draft)
limit	number	Anzahl der zurückzugebenden Elemente
offset	number	Offset für Paginierung

Antwort

{
  "policies": [
    {
      "id": "pol-123",
      "name": "Engineering Access Policy",
      "type": "role_based_access",
      "status": "active",
      "priority": 100,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total": 25,
  "limit": 10,
  "offset": 0
}

---

Richtlinie abrufen

Ruft Details für eine bestimmte Richtlinie ab.

GET /api/v1/policies/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Richtlinien-ID

Antwort

{
  "id": "pol-123",
  "name": "Engineering Access Policy",
  "description": "Defines expected access for engineering roles",
  "type": "role_based_access",
  "status": "active",
  "priority": 100,
  "rules": [
    {
      "condition": "role.department == 'Engineering'",
      "effect": "allow",
      "resources": ["app-github", "app-jira"]
    }
  ],
  "associated_roles": ["role-eng-senior", "role-eng-junior"],
  "target_applications": ["app-github", "app-jira"],
  "target_groups": [],
  "auto_approve": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-02-01T14:22:00Z"
}

---

Richtlinie erstellen

Erstellt eine neue Zugriffsrichtlinie.

POST /api/v1/policies

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Request Body

{
  "name": "Finance Access Policy",
  "description": "Defines expected access for finance roles",
  "type": "role_based_access",
  "priority": 90,
  "rules": [
    {
      "condition": "role.department == 'Finance'",
      "effect": "allow",
      "resources": ["app-sap", "app-netsuite"]
    }
  ],
  "associated_roles": ["role-finance-analyst"],
  "target_applications": ["app-sap", "app-netsuite"],
  "auto_approve": false
}

Richtlinientypen

Typ	Beschreibung
role_based_access	Richtlinien basierend auf Rollenzuweisungen
owner_account_approval	Richtlinien für Eigentümer-Konto-Beziehungen
application_access	Richtlinien für anwendungsspezifischen Zugriff
group_membership	Richtlinien für Gruppenmitgliedschaftsregeln

Antwort

Gibt das erstellte Richtlinienobjekt zurück.

---

Richtlinie aktualisieren

Aktualisiert eine bestehende Richtlinie.

PUT /api/v1/policies/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Richtlinien-ID

Request Body

Nur die zu aktualisierenden Felder einschließen.

Antwort

Gibt das aktualisierte Richtlinienobjekt zurück.

---

Richtlinie löschen

Löscht eine Richtlinie.

DELETE /api/v1/policies/{id}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Richtlinien-ID

Antwort

Gibt 204 No Content bei Erfolg zurück.

---

Richtlinien evaluieren

Evaluiert Richtlinien für einen Eigentümer.

POST /api/v1/policies/evaluate

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Request Body

{
  "owner_id": "own-123"
}

Antwort

{
  "owner_id": "own-123",
  "evaluations": [
    {
      "policy_id": "pol-123",
      "policy_name": "Engineering Access Policy",
      "result": "compliant",
      "matching_rules": 2,
      "violations": []
    }
  ]
}

---

Richtlinien nach Rolle abrufen

Ruft alle Richtlinien ab, die einer Rolle zugeordnet sind.

GET /api/v1/policies/by-role/{roleId}

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Path-Parameter

Parameter	Typ	Beschreibung
roleId	string	Rollen-ID

Antwort

{
  "policies": [
    {
      "id": "pol-123",
      "name": "Engineering Access Policy",
      "type": "role_based_access",
      "status": "active"
    }
  ]
}

---

Richtlinie aus Rolle generieren

Generiert eine Richtlinie basierend auf den Zugriffsmustern einer Rolle.

POST /api/v1/policies/generate-from-role

::: note Nur Administrator Dieser Endpoint erfordert die Administrator-Rolle. :::

Request Body

{
  "role_id": "role-123"
}

Antwort

Gibt das generierte Richtlinienobjekt basierend auf den gemeinsamen Anwendungen und Gruppen der Rolle zurück.

---

Richtlinienstatuswerte

Status	Beschreibung
draft	Richtlinie wird konfiguriert
active	Richtlinie ist aktiv und wird evaluiert
inactive	Richtlinie ist deaktiviert

---

Fehlerantworten

Statuscode	Beschreibung
400	Bad Request - Ungültige Richtlinienkonfiguration
401	Unauthorized - Authentifizierung erforderlich
403	Forbidden - Unzureichende Berechtigungen
404	Not Found - Richtlinie existiert nicht
409	Conflict - Richtlinienname existiert bereits
500	Internal Server Error

---

Verwandte Themen

• Policies - Benutzerhandbuch
• Roles API - Rollenverwaltungs-Endpoints
• Campaign Rules API - Regelverwaltungs-Endpoints
• API Reference - Vollständiger API-Index