JustRelate

Parameterelemente für Benutzer

Mit Funktionselementen kann man auf die Daten der Benutzer zugreifen. Mit dem user-get-Element können beispielsweise die Werte sämtlicher Benutzer-Parameter ermittelt werden. Möchte man spezifizieren, welche Benutzereigenschaften ausgelesen oder gesetzt werden sollen, so werden Parameterelemente verwendet. Im Folgenden werden die Benutzer-Parameter und die zugehörigen Parameterelemente aufgeführt.

defaultGroup
Bedeutung: Standardgruppe des Benutzers.

Definition:

<!ELEMENT defaultGroup (%cm.atom; | %cm.group-get;)*>

cm.group-get: siehe <group-where> <group-get> oder CRUL als DTD.
displayTitle
Bedeutung: Der in der HTML-Benutzerschnittstelle angezeigte Bezeichner des Benutzers (eine Kombination aus Login und vollem Namen).

Definition:

<!ELEMENT displayTitle (%cm.atom;)>
encryptedPassword
Bedeutung: Verschlüsseltes Passwort des Benutzers.

Definition:

<!ELEMENT encryptedPassword (%cm.atom;)>
email
Bedeutung: E-Mail-Adresse des Benutzers.

Definition:

<!ELEMENT email (%cm.atom;)>
externalUserAttrNames
Bedeutung: Liste der zusätzlichen Benutzerfelder des Benutzers.

Definition:

<!ELEMENT externalUserAttrNames ((userAttribute)* | (listitem)*)>
<!ELEMENT userAttribute (%cm.userAttribute-get;)>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.userAttribute-get: siehe <userAttribute-where> <userAttribute-get> oder CRUL als DTD.
getKeys
Bedeutung: Liste der mit user-get abfragbaren Parameter.

Definition:

<!ELEMENT getKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
globalPermissions
Bedeutung: Liste der globalen Rechte.

Definition:

<!ELEMENT globalPermissions (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
hasGlobalPermission
Bedeutung: Überprüft, ob der Benutzer das spezifizierte globale Recht hat.

Definition:

<!ELEMENT hasGlobalPermission (%cm.atom;)>
<!ATTLIST hasGlobalPermission
          permission (permissionGlobalExport | 
                      permissionGlobalRoot | 
                      permissionGlobalRTCEdit | 
                      permissionGlobalUserAttributeEdit | 
                      permissionGlobalUserEdit) CDATA #REQUIRED
>

Bedeutung der Attribute:

  • permission: spezifiziert ein globales Recht.

Beispiel:

<cm-request...>
  <user-where>
    <login>stan</login>
  </user-where>
  <user-get>
    <hasGlobalPermission permission="permissionGlobalRTCEdit"/>
  </user-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <user>
      <hasGlobalPermission permission="permissionGlobalRTCEdit">1
      </hasGlobalPermission>
    </user>
  </cm-code>
</cm-response>
groups
Bedeutung: Liste der Gruppen, in denen der Benutzer Mitglied ist.

Definition:

<!ELEMENT groups ((group)* | (listitem)*)>
<!ELEMENT group (%cm.atom; | %cm.group-get;)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>

cm.group-get: siehe <group-where> <group-get> oder CRUL als DTD.
hasPassword
Bedeutung: Prüft, ob der Benutzer das angegebene Passwort hat.

Definition:

<!ELEMENT hasPassword (%cm.atom;)>
<!ATTLIST hasPassword
          password CDATA #REQUIRED
>

Bedeutung der Attribute:

  • password: spezifiziert das Passwort (Klartext).

Beispiel:

<cm-request...>
  <user-where>
    <login>stan</login>
  </user-where>
  <user-get>
    <hasPassword password="xyz123"/>
  </user-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <user>
      <hasPassword password="xyz123">0</hasPassword>
    </user>
  </cm-code>
</cm-response>
isSuperUser
Bedeutung: Zeigt an, ob der Benutzer ein Superuser ist (1= ist Superuser; 0 = ist kein Superuser).

Definition:

<!ELEMENT isSuperUser (%cm.atom;)>
isOwnerOf
Bedeutung: Zeigt an, ob der Benutzer der Verwalter eines anderen Benutzers oder einer Benutzgruppe ist (1= ist Verwalter; 0= ist nicht der Verwalter).

Definition:

<!ELEMENT isOwnerOf (%cm.atom;)>
<!ATTLIST isOwnerOf
          login CDATA #REQUIRED
>

Bedeutung der Attribute:

  • login: spezifiziert einen Benutzer oder eine Benutzergruppe.

Beispiel:

<cm-request...>
  <user-where>
    <login>lisa</login>
  </user-where>
  <user-get>
    <isOwnerOf login="NewsEditors"/>
  </user-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <user>
      <isOwnerOf login="NewsEditors">1</isOwnerOf>
    </user>
  </cm-code>
</cm-response>
login
Bedeutung: Login des Benutzers.

Definition:

<!ELEMENT login (%cm.atom;)>
owner
Bedeutung: Der Verwalter des Benutzers.
Wenn ein Benutzer angelegt wird, wird der eingeloggte Benutzer automatisch zum direkten Verwalter (owner) des neuen Benutzers. Der Verwalter hat das Recht, Felder und Rechte des neuen Benutzers zu ändern. Das Login des direkten Verwalters ist im Parameter owner des Benutzers eingetragen.
Der Verwalter eines Benutzers hat auch die Möglichkeit, einen anderen Wert in den Parameter owner des Benutzers einzutragen. Dieser andere Wert kann entweder ein Login oder ein Gruppenname sein. Mit der Eintragung eines neuen Verwalters tritt der vorherige Verwalter seine Rechte an einen anderen Benutzer oder an eine Gruppe ab.
Ist im Parameter owner eines Benutzers eine Gruppe eingetragen, so gelten alle Mitglieder der Gruppe als indirekte Verwalter.
Um die Parameter eines Benutzers ändern zu können, muss man der direkte oder der indirekte Verwalter des Benutzers sein und das Recht permissionGlobalUserEdit haben. Ein Benutzer kann also seine Daten nicht selbst ändern, es sei denn, er ist sein eigener direkter oder indirekter Verwalter.
Die Wirkungsweise des Parameters owner gilt analog auch für Gruppen.

Definition:

<!ELEMENT owner (%cm.atom;)>
password
Bedeutung: Das Klartext-Passwort des Benutzers.

Definition:

<!ELEMENT password (%cm.atom;)>
realName
Bedeutung: Voller Name des Benutzers.

Definition:

<!ELEMENT realName (%cm.atom;)>
setKeys
Bedeutung: Liste der mit user-set setzbaren Parameter.

Definition:

<!ELEMENT setKeys (listitem)*>
<!ELEMENT listitem (%cm.atom; | listitem | dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
userLocked
Bedeutung: Gibt an, ob der Benutzer gesperrt ist (1= ist gesperrt; 0= ist nicht gesperrt).

Definition:

<!ELEMENT userLocked (%cm.atom;)>
© JustRelate Group GmbH · 2024