Berechtigungen & Sicherheitskonfiguration
Diese Seite beschreibt die API-Endpunkte für Benutzer- und Rollenberechtigungen sowie die Domänenverwaltung.
Diese Endpunkte erfordern Administratorrechte. Änderungen wirken sich sofort auf alle Benutzer der Organisation aus. Fehlerhafte Berechtigungsänderungen — z. B. das Entziehen von PermissionsAdministrate bei allen Benutzern — können dazu führen, dass Sie sich und alle anderen Administratoren dauerhaft aussperren und der Zugriff über die API nicht wiederhergestellt werden kann.
UserPermission
Die UserPermission-Entität definiert die Berechtigungen einzelner Benutzer. Jeder Eintrag enthält eine Liste von Berechtigungen für verschiedene Bereiche. Benutzerrechte gelten für den gesamten Account bzw. für bestimmte Abteilungen (Divisons). In diesem Fall sind DivisionIds gesetzt.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
Id | guid | Eindeutige ID. |
UserPermissionId | guid | Berechtigungs-ID. |
ContactIds | guid[]? | Liste der zugeordneten Kontakt-IDs. |
DivisionIds | guid[]? | Liste der zugeordneten Abteilungs-IDs, falls die Berechtitung auf eine Abteilung eingeschränkt ist. |
ReadOnlyLicense | bool | Nur-Lesen-Lizenz. |
PermissionsAdministrate | bool | Voller Administratorzugriff. |
PATAccess | bool | Personal Access Token erstellen und verwenden. |
ProjectRead | bool | Projekte anzeigen. |
ProjectModify | bool | Projekte bearbeiten. |
ProjectCreate | bool | Projekte erstellen. |
ProjectDelete | bool | Projekte löschen. |
ProjectLock | bool | Projekte sperren. |
ProjectMemberModify | bool | Projektmitglieder verwalten. |
ProjectPriorityModify | bool | Projektpriorität ändern. |
ProjectRequestCreate | bool | Projektanträge erstellen. |
ProjectRequestRelease | bool | Projektanträge genehmigen oder ablehnen. |
TaskItemAccess | bool | Aufgaben anzeigen. |
TaskItemModify | bool | Aufgaben bearbeiten. |
TaskItemDelete | bool | Aufgaben löschen. |
TaskItemStateModify | bool | Aufgabenstatus ändern. |
TaskItemCommentAdd | bool | Kommentare zu Aufgaben hinzufügen. |
TaskItemCommentDelete | bool | Aufgabenkommentare löschen. |
TaskItemProjectFieldsCreate | bool | Projektdefinierte Felder für Aufgaben erstellen. |
OwnTaskItemAccess | bool | Nur eigene Aufgaben anzeigen. |
OwnTaskItemModify | bool | Nur eigene Aufgaben bearbeiten. |
OwnTaskItemDelete | bool | Nur eigene Aufgaben löschen. |
OwnTaskItemStateModify | bool | Nur Status eigener Aufgaben ändern. |
OwnTaskItemCommentDelete | bool | Nur eigene Aufgabenkommentare löschen. |
PrivateTasksCreate | bool | Private Aufgaben erstellen. |
TimeEntryAccess | bool | Alle Zeiteinträge anzeigen. |
TimeEntryModify | bool | Alle Zeiteinträge bearbeiten. |
UserTimeEntryAccess | bool | Eigene Zeiteinträge anzeigen. |
UserTimeEntryModify | bool | Eigene Zeiteinträge bearbeiten. |
DocumentAccess | bool | Dokumente anzeigen. |
DocumentModify | bool | Dokumente bearbeiten. |
BudgetAccess | bool | Budgets anzeigen. |
BudgetModify | bool | Budgets bearbeiten. |
PlanningAccess | bool | Planung anzeigen. |
PlanningModify | bool | Planung bearbeiten. |
MindMapAccess | bool | Mind Maps anzeigen. |
MindMapModify | bool | Mind Maps bearbeiten. |
CheckListAccess | bool | Listen anzeigen. |
CheckListModify | bool | Listen bearbeiten. |
ManageAccess | bool | Betreuung anzeigen. |
ManageModify | bool | Betreuung bearbeiten. |
RiskAccess | bool | Risiken anzeigen. |
RiskModify | bool | Risiken bearbeiten. |
AssessmentAccess | bool | Projektbewertungen anzeigen. |
AssessmentModify | bool | Projektbewertungen bearbeiten. |
NoteAccess | bool | Kommentare anzeigen. |
AddNote | bool | Kommentare hinzufügen. |
DeleteNote | bool | Kommentare löschen. |
DeleteUserNote | bool | Nur eigene Kommentare löschen. |
ReportRead | bool | Berichte anzeigen. |
ReportModify | bool | Berichte bearbeiten. |
ResourceAllocationRead | bool | Auslastung anzeigen. |
DashboardsAccess | bool | Dashboards anzeigen. |
DashboardsModify | bool | Dashboards bearbeiten. |
ProjectDashboardAccess | bool | Projektdashboards anzeigen. |
ProjectDashboardModify | bool | Projektdashboards bearbeiten. |
PortfoliosModify | bool | Portfolios bearbeiten. |
ContactsModify | bool | Kontakte bearbeiten. |
ShowContactsSection | bool | Kontaktbereich in der Navigation anzeigen. |
ShowAllContactsInProjects | bool | Alle Kontakte beim Hinzufügen von Projektmitgliedern anzeigen. |
Endpunkte
Alle Benutzerberechtigungen abrufen
/odata/UserPermissionUnterstützt OData-Abfrageoptionen.
Dieser Endpunkt ist standardmäßig deaktiviert. Kontaktieren Sie den InLoox Support, wenn Sie Hilfe bei der Aktivierung benötigen.
Neue Benutzerberechtigungen erstellen
/odata/UserPermission| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiUserPermission> | ✅ | JSON-Objekt mit den Berechtigungseigenschaften. |
Funktionen
Berechtigungen des aktuellen Benutzers abrufen
/odata/UserPermission/MyGlobalUserPermissionSet()Verwenden Sie diesen Endpunkt, um zur Laufzeit zu prüfen, welche Aktionen dem aktuellen Benutzer zur Verfügung stehen.
OData-Abfragebeispiele
GET /odata/UserPermission/MyGlobalUserPermissionSet()
POST /odata/UserPermission
Content-Type: application/json
{
"ContactIds": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
"ProjectRead": true,
"ProjectModify": true,
"ProjectCreate": true,
"TaskItemAccess": true,
"TaskItemModify": true,
"TimeEntryAccess": true,
"TimeEntryModify": true,
"ReadOnlyLicense": false
}
RolePermission
Die RolePermission-Entität definiert die Standardberechtigungen für jede Rolle. Sie teilt dieselben Berechtigungsfelder wie UserPermission, plus diese rollenspezifischen Konfigurationsfelder:
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
RoleType | int | Rollentyp-Identifikator. |
RoleEnabled | bool | Ob die Rolle aktiviert ist. |
CustomName | string? | Benutzerdefinierter Rollenname. Nur verfügbar in InLoox Enterprise Plus sowie InLoox Self-Hosted. |
Der Endpunkt GET /odata/RolePermission gibt den vollständigen Satz an Berechtigungsfeldern (wie bei UserPermission oben) für jede Rolle zurück. Der PATCH-Endpunkt akzeptiert dieselben Berechtigungs-Booleans sowie die hier aufgeführten rollenspezifischen Felder.
Endpunkte
Alle Rollenberechtigungen abrufen
/odata/RolePermissionUnterstützt OData-Abfrageoptionen.
Eine Rollenberechtigung aktualisieren
/odata/RolePermission({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ID der zu aktualisierenden Rollenberechtigung. |
Body | Delta<ApiRolePermission> | ✅ | JSON-Objekt mit den Rollenberechtigungseigenschaften. |
Änderungen an Rollenberechtigungen werden sofort für alle Benutzer dieser Rolle wirksam. Das Deaktivieren einer Rolle oder das Entfernen kritischer Berechtigungen kann ganze Benutzergruppen aussperren.
ValidInviteDomain
Die ValidInviteDomain-Entität verwaltet die erlaubten Domänen für Benutzereinladungen. Nur E-Mail-Adressen mit einer hier hinterlegten Domäne können eingeladen werden.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
ValidInviteDomainId | guid | Eindeutige ID der Domäne. |
DomainName | string | Der Domänenname (z. B. beispiel.de). |
Endpunkte
Alle erlaubten Einladungsdomänen abrufen
/odata/ValidInviteDomainUnterstützt OData-Abfrageoptionen.
Eine Einladungsdomäne nach ID abrufen
/odata/ValidInviteDomain({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ValidInviteDomainId. |
Eine neue Einladungsdomäne hinzufügen
/odata/ValidInviteDomain| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiValidInviteDomain> | ✅ | JSON-Objekt mit den Domäneneigenschaften. |
Eine Einladungsdomäne aktualisieren
/odata/ValidInviteDomain({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ValidInviteDomainId. |
Body | Delta<ApiValidInviteDomain> | ✅ | JSON-Objekt mit den Domäneneigenschaften. |
Eine Einladungsdomäne löschen
/odata/ValidInviteDomain({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ValidInviteDomainId. |
Das Löschen einer Einladungsdomäne verhindert, dass neue Benutzer mit dieser Domäne eingeladen werden können. Diese Aktion kann nicht rückgängig gemacht werden.
Gibt 204 No Content bei Erfolg zurück.
ValidLoginDomain
Die ValidLoginDomain-Entität verwaltet die erlaubten Domänen für die Benutzeranmeldung über Microsoft 365. Nur Benutzer mit einer E-Mail-Adresse in einer dieser Domänen können sich anmelden, falls die Domain-Anmelderichtlinie für Microsoft 365 aktiv ist.
Datenmodell
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
ValidLoginDomainId | guid | Eindeutige ID der Domäne. |
DomainName | string | Der Domänenname (z. B. firma.de). |
Endpunkte
Alle erlaubten Microsoft 365 Anmeldedomänen abrufen
/odata/ValidLoginDomainUnterstützt OData-Abfrageoptionen.
Eine Microsoft 365 Anmeldedomäne nach ID abrufen
/odata/ValidLoginDomain({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ValidLoginDomainId. |
Eine neue Microsoft 365 Anmeldedomäne hinzufügen
/odata/ValidLoginDomain| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Body | Delta<ApiValidLoginDomain> | ✅ | JSON-Objekt mit den Domäneneigenschaften. |
Eine Anmeldedomäne aktualisieren
/odata/ValidLoginDomain({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ValidLoginDomainId. |
Body | Delta<ApiValidLoginDomain> | ✅ | JSON-Objekt mit den Domäneneigenschaften. |
Eine Anmeldedomäne löschen
/odata/ValidLoginDomain({key})| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
key | guid | ✅ | Die ValidLoginDomainId. |
Das Löschen einer Anmeldedomäne verhindert, dass sich neue Benutzer mit dieser Domäne anmelden können.
Gibt 204 No Content bei Erfolg zurück.