Folgende SOAP-Methoden werden speziell für die Interaktion mit Benutzern bereitgestellt.
getByUsername
User anhand des Usernamen finden
EvalancheUser getByUsername(string username)
Details
Parameter
- string username: Username des zu suchenden Benutzers
Rückgabewert
- EvalancheUser: Objekt mit folgenden Attributen:
- int id: Id des Benutzers
- int mandator_id: Id des Mandanten. Der Wert 0 signalisiert einen globalen Benutzer
Bitte beachten Sie, dass globale Benutzer, welche über die Systemoberfläche in einen Mandanten gewechselt haben, von dem Zeitpunkt als Mandanten-Benutzer gelten und den Parameter mandator_id ignorieren, bis der globale Benutzer über die Systemoberfläche wieder auf die “Globale Übersicht” gewechselt hat.
- string username: Username des Benutzers
- string email: E-Mail Adresse des Benutzers
- int salutation: Anrede des Benutzers (0 = leer, 1 = Frau, 2 = Herr)
- string firstname: Vorname des Benutzers
- string name: Nachname des Benutzers
- string description: Beschreibung des Benutzers
- int security_guideline_id: Id der Sicherheitsrichtlinie, welchem dem Benutzer zugeordnet ist
- int[] role_ids: Liste mit Ids von Rollen, welchen der Benutzer angehört
- bool disabled: true , wenn der Benutzer deaktiviert ist
- password: Passwort des Benutzers, hier immer der Wert *SCRAMBLED*
Benötigte Rechte
Benutzer verwalten
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="https://scnem.com/soap.php/soap/user">
<soapenv:Header/>
<soapenv:Body>
<user:getByUsername>
<username>USERNAME</username>
</user:getByUsername>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/user">
<SOAP-ENV:Body>
<ns1:getByUsernameResponse>
<getByUsernameResult>
<id>USER_ID</id>
<mandator_id>MANDATOR</mandator_id>
<username>USER_NAME</username>
<email>USER_EMAIL</email>
<salutation>SALUTATION</salutation>
<firstname>FIRSTNAME</firstname>
<name>NAME</name>
<description>DESCRIPTION</description>
<security_guideline_id>SECURITY_GUIDLINE_ID</security_guideline_id>
<role_ids>
<item>ROLE_ID</item>
[...]
</role_ids>
<disabled>DISABLED</disabled>
<password>*SCRAMBLED*</password>
</getByUsernameResult>
</ns1:getByUsernameResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAll
Liste aller Benutzer auslesen
EvalancheUser[] getAll(int mandator_id)
Details
Parameter
- int mandator_id: Id des Mandanten, dessen Benutzer zurückgeliefert werden sollen. Der Wert 0 liefert globale Benutzer zurück
Bitte beachten Sie, dass globale Benutzer, welche über die Systemoberfläche in einen Mandanten gewechselt haben, von dem Zeitpunkt als Mandanten-Benutzer gelten und den Parameter mandator_idignorieren, bis der globale Benutzer über die Systemoberfläche wieder auf die “Globale Übersicht” gewechselt hat.
Rückgabewert
- EvalancheUser[]: Liste von Objekten analog zu User anhand des Usernamen finden
Benötigte Rechte
Benutzer verwalten
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="https://scnem.com/soap.php/soap/user">
<soapenv:Header/>
<soapenv:Body>
<user:getAll>
<mandator_id>MANDATOR_ID</mandator_id>
</user:getAll>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/user">
<SOAP-ENV:Body>
<ns1:getAllResponse>
<getAllResult>
<item>
<id>USER_ID</id>
<mandator_id>MANDATOR</mandator_id>
<username>USER_NAME</username>
<email>USER_EMAIL</email>
<salutation>SALUTATION</salutation>
<firstname>FIRSTNAME</firstname>
<name>NAME</name>
<description>DESCRIPTION</description>
<security_guideline_id>SECURITY_GUIDLINE_ID</security_guideline_id>
<role_ids>
<item>ROLE_ID</item>
[...]
</role_ids>
<disabled>DISABLED</disabled>
<password>*SCRAMBLED*</password>
</item>
[...]
</getAllResult>
</ns1:getAllResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
update
Benutzerdaten aktualisieren und Benutzer anlegen
EvalancheUser update(EvalancheUser user)
Details
Parameter
- EvalancheUser: Userdaten analog zum Rückgabewert unter User anhand des Usernamen finden. Ist das Attribut id gleich 0, wird ein neuer Benutzer angelegt. Es muss eine lokal existierende Sicherheitsrichtlinie ausgewählt werden. Ggfs. muss diese erst angelegt werden.
Rückgabewert
- EvalancheUser: Objekt analog zu User anhand des Usernamen finden
Benötigte Rechte
Benutzer verwalten
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:user="https://scnem.com/soap.php/soap/user">
<soapenv:Header/>
<soapenv:Body>
<user:update>
<user>
<!--You may enter the following 12 items in any order-->
<id>USER_ID</id>
<mandator_id>MANDATOR_ID</mandator_id>
<username>USERNAME</username>
<email>USER_EMAIL</email>
<salutation>SALUTATION</salutation>
<firstname>FIRSTNAME</firstname>
<name>NAME</name>
<description>DESCRIPTION</description>
<security_guideline_id>SECURITY_GUIDLINE_ID</security_guideline_id>
<role_ids>
<!--Zero or more repetitions:-->
<item>ROLE_ID</item>
</role_ids>
<disabled>DISABLED</disabled>
<password>NEW_PASSWORD</password>
</user>
</user:update>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/user">
<SOAP-ENV:Body>
<ns1:getByUsernameResponse>
<getByUsernameResult>
<id>USER_ID</id>
<mandator_id>MANDATOR</mandator_id>
<username>USER_NAME</username>
<email>USER_EMAIL</email>
<salutation>SALUTATION</salutation>
<firstname>FIRSTNAME</firstname>
<name>NAME</name>
<description>DESCRIPTION</description>
<security_guideline_id>SECURITY_GUIDLINE_ID</security_guideline_id>
<role_ids>
<item>ROLE_ID</item>
[...]
</role_ids>
<disabled>DISABLED</disabled>
<password>*SCRAMBLED*</password>
</getByUsernameResult>
</ns1:getByUsernameResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>