Parameterelemente für Requests mit userProxy-Elementen

Mit Hilfe von Funktionselementen kann man über den Benutzermanager-Proxy auf Benutzerdaten zugreifen. So lassen sich beispielsweise mit dem userProxy-get-Element die Werte sämtlicher Benutzer-Parameter ermitteln. Um zu spezifizieren, welche Benutzereigenschaften ausgelesen oder gesetzt werden sollen, verwendet man Parameterelemente. Welche Parameterelemente verwendet werden können, ist vom externen Benutzermanager abhängig. Im Folgenden werden die verfügbaren userProxy-Parameterelemente aufgeführt. Mit Ausnahme von description entsprechen sie den user-Parameterelementen (siehe Parameterelemente für Benutzer).

defaultGroup
Bedeutung: Die Standardgruppe des Benutzers.

Definition:

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

cm.group-get: siehe <group-where> <group-get> oder CRUL als DTD.
description
Bedeutung: Liefert die Daten des angegebenen Benutzers.

Definition:

<!ELEMENT description (dictitem)*>
<!ELEMENT dictitem (key, value)>
<!ELEMENT key (%cm.atom;)>
<!ELEMENT value (%cm.atom; | listitem | dictitem)*>
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: Das verschlüsselte Passwort des Benutzers.

Definition:

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

Definition:

<!ELEMENT email (%cm.atom;)>
externalUserAttrNames
Bedeutung: Liste der 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: Die 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: Die 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...>
  <userProxy-where>
    <login>stan</login>
  </userProxy-where>
  <userProxy-get>
    <hasGlobalPermission permission="permissionGlobalRTCEdit"/>
  </userProxy-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <userProxy>
      <hasGlobalPermission permission="permissionGlobalRTCEdit">1
      </hasGlobalPermission>
    </userProxy>
  </cm-code>
</cm-response>
groups
Bedeutung: Die 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: Überprüft, ob das angegebene Passwort das Passwort des Benutzers ist (1= ist das Passwort des Benutzers; 0= ist nicht das Passwort des Benutzers).

Definition:

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

Bedeutung der Attribute:

  • password: spezifiziert das Passwort (Klartext).

Beispiel:

<cm-request...>
  <userProxy-where>
    <login>stan</login>
  </userProxy-where>
  <userProxy-get>
    <hasPassword password="xyz123"/>
  </userProxy-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <userProxy>
      <hasPassword password="xyz123">0</hasPassword>
    </userProxy>
  </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 der Verwalter; 0 = ist nicht der Verwalter).

Definition:

<!ELEMENT isOwnerOf (%cm.atom;)>
<!ATTLIST isOwnerOf
          user CDATA #IMPLIED
          group CDATA #IMPLIED
>

Bedeutung der Attribute:

  • user: spezifiziert einen Benutzer (login).
  • group: spezifiziert eine Benutzergruppe (name).

Beispiel:

<cm-request...>
  <userProxy-where>
    <login>lisa</login>
  </userProxy-where>
  <userProxy-get>
    <isOwnerOf group="NewsEditors"/>
  </userProxy-get>
</cm-request>
 
<cm-response...>
  <cm-code numeric="0" phrase="ok">
    <userProxy>
      <isOwnerOf group="NewsEditors">1</isOwnerOf>
    </userProxy>
  </cm-code>
</cm-response>
login
Bedeutung: Das 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: Der volle Name des Benutzers.

Definition:

<!ELEMENT realName (%cm.atom;)>
setKeys
Bedeutung: Die 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;)>