Hilfe-Center
  1. Startseite
  2. Technische Referenz
  3. API
  4. API-Funktionen
  5. Persons

Persons

Personen können Benutzer als auch Administratoren sein. Sie definieren sich anhand ihres Typs und unterscheiden sich in ein paar Properties und Funktionen. Nähere Informationen dazu finden sich auf der Seite Benutzer vs Administrator.

Function GetByID(ID As Integer) As iPerson

Person anhand der ID erhalten

Function GetByPasswordResetToken(Token As String) As iPerson

Gibt eine Person anhand des Passwort-Zurücksetzen-Token zurück

Existiert keine entsprechende Person, wird Nothing zurückgegeben

Bezieht sich nur auf Personen vom Typ User

Function GetByEMailAddress(
    EMailAddress As String,
    Optional FindAdmins As Boolean = False
) As iPerson

Gibt eine Person anhand der EMail-Adresse zurück.
Stamdardmäßig steht der Parameter FindAdmins auf False, in diesem Fall werden nur User gefunden. Die Angabe einer Mail-Adresse eines Administrators führt dann zur Rückgabe von Nothing, auch wenn es einen Administrator zur Adresse gibt.

Sollen Administratoren gefunden werden, muss FindAdmis auf True gesetzt werden, in diesem Fall werden dann nur Administratoren gefunden und keine User.

Existiert gar keine entsprechende Person, wird Nothing zurückgegeben

Public Shared Function CreateUser(
    NickName As String,
    FirstName As String,
    LastName As String,
    EMailAddress As String,
    Password As String,
    Modifier As iPerson,
    Optional PagesToAuth As IEnumerable(Of iPage) = Nothing,
    Optional GroupsToAuth As IEnumerable(Of iPersonGroup) = Nothing,
    Optional Active As Boolean = False
) As PersonCreateResult [V2]

Einen neuen Benutzer anlegen.

Der Benutzer wird standardmäßig inaktiv angelegt. Er muss anschließend über das Backend aktiviert werden.
Optional kann er auch direkt über Active:=True aktiviert werden, dazu siehe den Hinweis unten.

Dem Benutzer können direkt Seiten zur Ansicht und/oder Benutzergruppen zugeordnet werden.

Es gelten die gleichen Validierungen wie im Backend.

Damit diese Funktion genutzt werden kann muss die Einstellung "Benutzerverwaltung über die API erlauben" aktiviert sein.

  • NickName: Der Anmeldename des Nutzers
  • FirstName: Der Vorname des Nutzers
  • LastName: Der Nachname des Nutzers
  • EMailAddress: Die E-Mail-Adresse des Nutzers
  • Password: Das Passwort des Nutzers
  • Modifier: Objekt der Person, die den Eintrag erstellt
  • Optionale Parameter:
    • PagesToAuth: Liste von Seiten die dem Nutzer gleich zugeordnet werden
    • GroupsToAuth: Liste von Benutzergruppen die dem Nutzer gleich zugeordnet werden
    • Active: Soll der Nutzer gleich Aktiv sein, wenn nicht, muss dieser im Backend aktiviert werden

Wichtig!
Wird eine Person direkt mit Active=True angelegt, findet keine weitere Validierung statt, ob der Nutzer Zugriff zur hinterlegten Mail hat. Das Sicherstellen der Integrität der angelegten Person liegt in diesem Fall beim Webseitenersteller.

War dieser Beitrag hilfreich?
1 von 1 fanden dies hilfreich.
Schade! Bitte teilen Sie uns doch mit was Ihnen nicht weitergeholfen hat.
Es ist ein technisches Problem aufgetreten. Bitte wenden Sie sich telefonisch oder per E-Mail an uns.