« Zurück zu Produkt

Dokumentation

IPS_GetUser

 array IPS_GetUser (string $Benutzername) 

Parameterliste

Benutzername

Name des Benutzers (case-sensitiv)

Rückgabewert

Folgende Informationen stehen als key => value Paare zur Verfügung:

Index Typ Beschreibung
UserName string Name des Benutzers
UserType integer Typ des Benutzers (0 (USER_TYPE_LOCAL): Lokales Konto, 1 (USER_TYPE_LDAP): LDAP)
FirstName string Vorname
LastName string Nachname
EMail string E-Mail-Adresse
BindDN string BindDN für die Anmeldung am LDAP-Server (nur für LDAP-Benutzer relevant)
IsActive boolean TRUE, wenn der Benutzer aktiv ist und sich anmelden kann
Roles array Namen der direkt zugewiesenen Rollen
Permissions array Direkt zugewiesene Berechtigungen, siehe Berechtigungen

Berechtigungen

Index Typ Beschreibung
ObjectID integer ID des Objekts, für das die Berechtigung gilt
Operation string Name der Operation, z.B. VISUALIZATION
Recursive boolean TRUE, wenn die Berechtigung auch für alle Objekte unterhalb des Objekts gilt

Beschreibung

Die Funktion liefert ein Array mit Informationen über den Benutzer Benutzername. Das Passwort wird nicht zurückgegeben, es wird ausschließlich als Hash gespeichert. Roles und Permissions enthalten nur die direkt dem Benutzer zugewiesenen Einträge; Berechtigungen, die sich über Rollen ergeben, können mit IPS_GetRole ausgelesen bzw. mit IPS_UserHasPermission geprüft werden.

Für den Benutzer @admin liefert die Funktion den Vornamen "Default" und den Nachnamen "Administrator" ohne Rollen und Berechtigungen, da dieser ohnehin alle Berechtigungen besitzt.

Existiert der Benutzer nicht, schlägt die Funktion mit "User with name '…' does not exist" fehl. Die Funktion erfordert weder das RBAC-Feature in der Lizenz noch Administratorrechte.

Siehe auch: IPS_GetUserList, IPS_UserExists

Beispiel

print_r(IPS_GetUser('anna'));

/* liefert z.B.:
Array
(
    [BindDN] => 
    [EMail] => anna@example.com
    [FirstName] => Anna
    [IsActive] => 1
    [LastName] => Muster
    [Permissions] => Array
        (
            [0] => Array
                (
                    [ObjectID] => 12345
                    [Operation] => VISUALIZATION
                    [Recursive] => 
                )

        )

    [Roles] => Array
        (
            [0] => visu
        )

    [UserName] => anna
    [UserType] => 0
)
*/
Haben Sie noch Fragen?