ALM Site Administration API Type Library
GetAllUsers Method
Returns all users and their properties.
Visual Basic
Public Function GetAllUsers() As String
Return Type

On success, returns an XML string containing the user properties.

Return Value Details
The properties of the GetAllUsers XML return string:

  • USER_ID    -    The new user ID number.
  • USER_NAME    -     The user name.
  • ACC_IS_ACTIVE    -    For internal use.
  • FULL_NAME    -    The full name of the user.
  • EMAIL    -    The email of the user.
  • USER_PASSWORD    -    The encryption of the user password.
  • DESCRIPTION    -    The description of the user.
  • PHONE_NUMBER    -   The phone number of the user.
  • LAST_UPDATE     -    For internal use.
  • US_DOM_AUTH    -    Domain name for use with LDAP authorization.
  • US_REPORT_ROLE    -  For internal use.
Return Value Example
<?xml version="1.0"?>
            <LAST_UPDATE>2007-06-19 17:56:08</LAST_UPDATE>
            <USER_NAME>new user 2</USER_NAME>
            <FULL_NAME>New User</FULL_NAME>
            <DESCRIPTION>This is new user</DESCRIPTION>
            <LAST_UPDATE>2007-07-01 14:28:43</LAST_UPDATE>
Private Sub GetAllUsers()

'The following Visual Basic example gets all the users
' and their properties.
    Dim sReply As String
On Error GoTo err
    sReply = m_SAClient.GetAllUsers
    MsgBox sReply
    Exit Sub

    MsgBox "Program failed:" + err.Description
End Sub
See Also