User Type

Represents a user account. Users can be identified by a unique ID or username. Users can also be organized into groups for easier management of permissions.

Type Template

<...>
    <creationDate>xs:dateTime</creationDate>
    <email>xs:string</email>
    <emailVisible>xs:boolean</emailVisible>
    <enabled>xs:boolean</enabled>
    <firstName>xs:string</firstName>
    <ID>xs:long</ID>
    <lastName>xs:string</lastName>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <nameVisible>xs:boolean</nameVisible>
    <password>xs:string</password>
    <username>xs:string</username>
<...>

Note: Element descriptions are split into information that's relevant when you're creating an instance of this type and information relevant when you're receiving an instance of it. Occasionally these will differ.

Elements

Element	Description
creationDate	Setting Sets the user account's creation date. In most cases, the creation date will default to when the user was entered into the system. However, the date needs to be set manually when importing data. In other words, skin authors should ignore this since it only intended for system maintenance. Getting Returns the date that the user account was created.
email	Setting Sets the user's email address. Consider the email address to be a required field of a user account; it is critical to the success of many user operations. Getting Returns the user's email address. Consider the email address to be a required field of a user account; it is critical to the success of many user operations. If the user has set their email to be not visible, this value will be null.
emailVisible	Setting Sets whether a user's email is visible to other users. If the email address is set to be hidden, an attempt to retrieve it will return null. Getting Returns true if the user has chosen to make their email visible to other users. If the email field is not visible, an attempt to retrieve it will return null.
enabled	Setting Sets the whether or not this user account is enabled. Getting Returns true if the user account is enabled.
firstName	Setting Sets the user's first name. The user's first name does not have to be to be unique in the system. NOTE: firstName is only respected when the 'jive.user.lastname.firstname.enabled' system property is set to true. Getting Returns the user's first name. The user's first name does not have to be to be unique in the system. Some users may opt to not let others see their first name for privacy reasons. In that case, this value will be null. NOTE: firstName is only respected when the 'jive.user.lastname.firstname.enabled' system property is set to true.
ID	Setting Sets the user account's user ID. Getting Returns the user account's user ID. All IDs must be unique in the system.
lastName	Setting Sets the user's last name. The user's last name does not have to be to be unique in the system. NOTE: firstName is only respected when the 'jive.user.lastname.firstname.enabled' system property is set to true. Getting Returns the user's last name. The user's last name does not have to be to be unique in the system. Some users may opt to not let others see their last name for privacy reasons. In that case, this value will be null. NOTE: firstName is only respected when the 'jive.user.lastname.firstname.enabled' system property is set to true.
modificationDate	Setting Sets the date the user account was last modified. Skin authors should ignore this since it only intended for system maintenance. Getting Returns the date that the user account was last modified.
name	Setting Sets the user's name. This is the user's friendly name, rather than the one-word username. The user's name does not have to be to be unique in the system. Getting
nameVisible	Setting Sets whether a user's name is visible to other users. This is the user's friendly name, rather than the one-word username. If the name is set to not be visible, an attempt to retrieve it will return null. Getting Returns true if the user has chosen to make their name visible to other users. This is the user's friendly name, rather than the one-word username. If the name is not visible, an attempt to retrieve it will return null.
password	Setting Sets the user's password. The password should be passed in as plain text. The way the password is stored is implementation dependent. However, it is recommended to at least hash passwords with an algorithm such as MD5. Getting Returns the user's password as plain text.
username	Setting Set the user's username. Each username must be unique in the system. Getting Returns the user's username. Each username must be unique in the system.