Roles Endpoints

Die Roles API bietet Endpoints zur Verwaltung erkannter Rollen, Role Mining und Richtliniengenerierung.

Basis-URL

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

---

Rollen auflisten

Ruft alle Rollen ab.

GET /api/v1/roles

Antwort

{
  "roles": [
    {
      "id": "role-123",
      "name": "Engineering - Senior Developer",
      "department": "Engineering",
      "title": "Senior Developer",
      "owner_count": 25,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

---

Rolle abrufen

Ruft Details für eine bestimmte Rolle ab.

GET /api/v1/roles/{id}

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Rollen-ID

Antwort

Gibt das vollständige Rollenobjekt zurück.

---

Rolle erstellen

Erstellt eine neue Rolle.

POST /api/v1/roles

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

Request Body

{
  "name": "Finance - Analyst",
  "department": "Finance",
  "title": "Financial Analyst"
}

Antwort

Gibt das erstellte Rollenobjekt zurück.

---

Rolle aktualisieren

Aktualisiert eine bestehende Rolle.

PUT /api/v1/roles/{id}

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Rollen-ID

Antwort

Gibt das aktualisierte Rollenobjekt zurück.

---

Rolle löschen

Löscht eine Rolle.

DELETE /api/v1/roles/{id}

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Rollen-ID

Antwort

Gibt 204 No Content bei Erfolg zurück.

---

Rolleneinstellungen

Rolleneinstellungen abrufen

GET /api/v1/roles/settings

Antwort

{
  "mining_columns": ["department", "title"],
  "auto_regenerate": false,
  "minimum_owner_count": 2
}

Rolleneinstellungen aktualisieren

PUT /api/v1/roles/settings

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

Request Body

{
  "mining_columns": ["department", "title", "location"],
  "auto_regenerate": true
}

---

Rollen regenerieren

Löst Rollenneugenierung basierend auf aktuellen Einstellungen aus.

POST /api/v1/roles/regenerate

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

Antwort

{
  "status": "queued",
  "message": "Role regeneration initiated"
}

---

Rollenstatistiken abrufen

Ruft Rollenstatistiken ab.

GET /api/v1/roles/statistics

Antwort

{
  "total_roles": 150,
  "total_owners_with_roles": 1200,
  "avg_owners_per_role": 8,
  "roles_with_policies": 45
}

---

Eigentümerspalten abrufen

Ruft verfügbare Eigentümerspalten für Role Mining ab.

GET /api/v1/roles/owner-columns

Antwort

{
  "columns": [
    { "name": "department", "type": "string", "sample_values": ["Engineering", "Finance"] },
    { "name": "title", "type": "string", "sample_values": ["Developer", "Analyst"] },
    { "name": "location", "type": "string", "sample_values": ["New York", "London"] }
  ]
}

---

Rollenanalyse

Alle Rollen analysieren

POST /api/v1/roles/analyze-all

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

Antwort

{
  "status": "queued",
  "message": "Role analysis initiated"
}

Einzelne Rolle analysieren

POST /api/v1/roles/{id}/analyze

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Rollen-ID

Rollenanalyse abrufen

GET /api/v1/roles/{id}/analysis

Antwort

{
  "id": "analysis-123",
  "role_id": "role-123",
  "common_applications": [...],
  "common_groups": [...],
  "risk_assessment": {...},
  "created_at": "2024-02-01T10:00:00Z"
}

Analysehistorie abrufen

GET /api/v1/roles/{id}/analysis/history

---

Rollenbeziehungen

Rolle mit Eigentümern abrufen

GET /api/v1/roles/{id}/owners

Antwort

{
  "role": {...},
  "owners": [
    {
      "id": "own-123",
      "name": "John Doe",
      "email": "john.doe@company.com"
    }
  ]
}

Rollenanwendungen abrufen

GET /api/v1/roles/{id}/applications

Rollengruppen abrufen

GET /api/v1/roles/{id}/groups

Richtlinien nach Rolle abrufen

GET /api/v1/roles/{id}/policies

---

Richtlinie aus Rolle generieren

Generiert eine Richtlinie basierend auf den Zugriffsmustern einer Rolle.

POST /api/v1/roles/{id}/generate-policy

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

Path-Parameter

Parameter	Typ	Beschreibung
id	string	Rollen-ID

Antwort

Gibt das generierte Richtlinienobjekt zurück.

---

Fehlerantworten

Statuscode	Beschreibung
400	Bad Request - Ungültige Parameter
401	Unauthorized - Authentifizierung erforderlich
403	Forbidden - Unzureichende Berechtigungen
404	Not Found - Rolle existiert nicht
500	Internal Server Error

---

Verwandte Themen

• Policies API - Richtlinienverwaltungs-Endpoints
• Owners API - Eigentümerverwaltungs-Endpoints
• Role Configuration - Benutzerhandbuch
• API Reference - Vollständiger API-Index