Zum Hauptinhalt springen

Berechtigungen & Sicherheitskonfiguration

Diese Seite beschreibt die API-Endpunkte für Benutzer- und Rollenberechtigungen sowie die Domänenverwaltung.

Warnung

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

EigenschaftTypBeschreibung
IdguidEindeutige ID.
UserPermissionIdguidBerechtigungs-ID.
ContactIdsguid[]?Liste der zugeordneten Kontakt-IDs.
DivisionIdsguid[]?Liste der zugeordneten Abteilungs-IDs, falls die Berechtitung auf eine Abteilung eingeschränkt ist.
ReadOnlyLicenseboolNur-Lesen-Lizenz.
PermissionsAdministrateboolVoller Administratorzugriff.
PATAccessboolPersonal Access Token erstellen und verwenden.
ProjectReadboolProjekte anzeigen.
ProjectModifyboolProjekte bearbeiten.
ProjectCreateboolProjekte erstellen.
ProjectDeleteboolProjekte löschen.
ProjectLockboolProjekte sperren.
ProjectMemberModifyboolProjektmitglieder verwalten.
ProjectPriorityModifyboolProjektpriorität ändern.
ProjectRequestCreateboolProjektanträge erstellen.
ProjectRequestReleaseboolProjektanträge genehmigen oder ablehnen.
TaskItemAccessboolAufgaben anzeigen.
TaskItemModifyboolAufgaben bearbeiten.
TaskItemDeleteboolAufgaben löschen.
TaskItemStateModifyboolAufgabenstatus ändern.
TaskItemCommentAddboolKommentare zu Aufgaben hinzufügen.
TaskItemCommentDeleteboolAufgabenkommentare löschen.
TaskItemProjectFieldsCreateboolProjektdefinierte Felder für Aufgaben erstellen.
OwnTaskItemAccessboolNur eigene Aufgaben anzeigen.
OwnTaskItemModifyboolNur eigene Aufgaben bearbeiten.
OwnTaskItemDeleteboolNur eigene Aufgaben löschen.
OwnTaskItemStateModifyboolNur Status eigener Aufgaben ändern.
OwnTaskItemCommentDeleteboolNur eigene Aufgabenkommentare löschen.
PrivateTasksCreateboolPrivate Aufgaben erstellen.
TimeEntryAccessboolAlle Zeiteinträge anzeigen.
TimeEntryModifyboolAlle Zeiteinträge bearbeiten.
UserTimeEntryAccessboolEigene Zeiteinträge anzeigen.
UserTimeEntryModifyboolEigene Zeiteinträge bearbeiten.
DocumentAccessboolDokumente anzeigen.
DocumentModifyboolDokumente bearbeiten.
BudgetAccessboolBudgets anzeigen.
BudgetModifyboolBudgets bearbeiten.
PlanningAccessboolPlanung anzeigen.
PlanningModifyboolPlanung bearbeiten.
MindMapAccessboolMind Maps anzeigen.
MindMapModifyboolMind Maps bearbeiten.
CheckListAccessboolListen anzeigen.
CheckListModifyboolListen bearbeiten.
ManageAccessboolBetreuung anzeigen.
ManageModifyboolBetreuung bearbeiten.
RiskAccessboolRisiken anzeigen.
RiskModifyboolRisiken bearbeiten.
AssessmentAccessboolProjektbewertungen anzeigen.
AssessmentModifyboolProjektbewertungen bearbeiten.
NoteAccessboolKommentare anzeigen.
AddNoteboolKommentare hinzufügen.
DeleteNoteboolKommentare löschen.
DeleteUserNoteboolNur eigene Kommentare löschen.
ReportReadboolBerichte anzeigen.
ReportModifyboolBerichte bearbeiten.
ResourceAllocationReadboolAuslastung anzeigen.
DashboardsAccessboolDashboards anzeigen.
DashboardsModifyboolDashboards bearbeiten.
ProjectDashboardAccessboolProjektdashboards anzeigen.
ProjectDashboardModifyboolProjektdashboards bearbeiten.
PortfoliosModifyboolPortfolios bearbeiten.
ContactsModifyboolKontakte bearbeiten.
ShowContactsSectionboolKontaktbereich in der Navigation anzeigen.
ShowAllContactsInProjectsboolAlle Kontakte beim Hinzufügen von Projektmitgliedern anzeigen.

Endpunkte

Alle Benutzerberechtigungen abrufen

GET/odata/UserPermission

Unterstützt OData-Abfrageoptionen.

info

Dieser Endpunkt ist standardmäßig deaktiviert. Kontaktieren Sie den InLoox Support, wenn Sie Hilfe bei der Aktivierung benötigen.


Neue Benutzerberechtigungen erstellen

POST/odata/UserPermission
ParameterTypErforderlichBeschreibung
BodyDelta<ApiUserPermission>JSON-Objekt mit den Berechtigungseigenschaften.

Funktionen

Berechtigungen des aktuellen Benutzers abrufen

GET/odata/UserPermission/MyGlobalUserPermissionSet()
tipp

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

EigenschaftTypBeschreibung
RoleTypeintRollentyp-Identifikator.
RoleEnabledboolOb die Rolle aktiviert ist.
CustomNamestring?Benutzerdefinierter Rollenname. Nur verfügbar in InLoox Enterprise Plus sowie InLoox Self-Hosted.
info

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

GET/odata/RolePermission

Unterstützt OData-Abfrageoptionen.


Eine Rollenberechtigung aktualisieren

PATCH/odata/RolePermission({key})
ParameterTypErforderlichBeschreibung
keyguidDie ID der zu aktualisierenden Rollenberechtigung.
BodyDelta<ApiRolePermission>JSON-Objekt mit den Rollenberechtigungseigenschaften.
Warnung

Ä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

EigenschaftTypBeschreibung
ValidInviteDomainIdguidEindeutige ID der Domäne.
DomainNamestringDer Domänenname (z. B. beispiel.de).

Endpunkte

Alle erlaubten Einladungsdomänen abrufen

GET/odata/ValidInviteDomain

Unterstützt OData-Abfrageoptionen.


Eine Einladungsdomäne nach ID abrufen

GET/odata/ValidInviteDomain({key})
ParameterTypErforderlichBeschreibung
keyguidDie ValidInviteDomainId.

Eine neue Einladungsdomäne hinzufügen

POST/odata/ValidInviteDomain
ParameterTypErforderlichBeschreibung
BodyDelta<ApiValidInviteDomain>JSON-Objekt mit den Domäneneigenschaften.

Eine Einladungsdomäne aktualisieren

PATCH/odata/ValidInviteDomain({key})
ParameterTypErforderlichBeschreibung
keyguidDie ValidInviteDomainId.
BodyDelta<ApiValidInviteDomain>JSON-Objekt mit den Domäneneigenschaften.

Eine Einladungsdomäne löschen

DELETE/odata/ValidInviteDomain({key})
ParameterTypErforderlichBeschreibung
keyguidDie ValidInviteDomainId.
warnung

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

EigenschaftTypBeschreibung
ValidLoginDomainIdguidEindeutige ID der Domäne.
DomainNamestringDer Domänenname (z. B. firma.de).

Endpunkte

Alle erlaubten Microsoft 365 Anmeldedomänen abrufen

GET/odata/ValidLoginDomain

Unterstützt OData-Abfrageoptionen.


Eine Microsoft 365 Anmeldedomäne nach ID abrufen

GET/odata/ValidLoginDomain({key})
ParameterTypErforderlichBeschreibung
keyguidDie ValidLoginDomainId.

Eine neue Microsoft 365 Anmeldedomäne hinzufügen

POST/odata/ValidLoginDomain
ParameterTypErforderlichBeschreibung
BodyDelta<ApiValidLoginDomain>JSON-Objekt mit den Domäneneigenschaften.

Eine Anmeldedomäne aktualisieren

PATCH/odata/ValidLoginDomain({key})
ParameterTypErforderlichBeschreibung
keyguidDie ValidLoginDomainId.
BodyDelta<ApiValidLoginDomain>JSON-Objekt mit den Domäneneigenschaften.

Eine Anmeldedomäne löschen

DELETE/odata/ValidLoginDomain({key})
ParameterTypErforderlichBeschreibung
keyguidDie ValidLoginDomainId.
warnung

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.