SAClient Type Library - Application Lifecyle Management Site Administration API
CreateUserEx Method
The user name defined in the ALM database.
The full name of the user.
The new user email.
The new user phone.
The new user description.
The user's password.

The distinguished name (DN) of the user in the LDAP server. ALM uses the DN to locate the user in the LDAP server and and perform authentication.

Example of a distinguished name:

uid=emmaw,ou=qc,dc=mercury,dc=com

Description
Creates a new user and retrieves the user properties.
Syntax
Visual Basic
Public Function CreateUserEx( _
   ByVal UserName As String, _
   ByVal FullName As String, _
   ByVal Email As String, _
   ByVal Phone As String, _
   ByVal Description As String, _
   ByVal password As String, _
   ByVal domainAuth As String _
) As String
Parameters
UserName
The user name defined in the ALM database.
FullName
The full name of the user.
Email
The new user email.
Phone
The new user phone.
Description
The new user description.
password
The user's password.
domainAuth

The distinguished name (DN) of the user in the LDAP server. ALM uses the DN to locate the user in the LDAP server and and perform authentication.

Example of a distinguished name:

uid=emmaw,ou=qc,dc=mercury,dc=com

Return Type

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

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

Return Value Example

<?xml version="1.0"?>
<CreateUser>
    <USER_ID>253</USER_ID>
    <USER_NAME>alex_td</USER_NAME>
    <ACC_IS_ACTIVE>Y</ACC_IS_ACTIVE>
    <FULL_NAME>Alex Dashevsky</FULL_NAME>
    <LAST_UPDATE>1228211811130</LAST_UPDATE>
    <USERS_VERSION>1228211811130</USERS_VERSION>
    <US_REPORT_ROLE>0</US_REPORT_ROLE>
    <EMAIL>alex_td@abc.com</EMAIL>
    <USER_PASSWORD>460831</USER_PASSWORD>
    <DESCRIPTION>QualityCenter_Demo</DESCRIPTION>
    <PHONE_NUMBER>301-3432778</PHONE_NUMBER>
    <US_DOM_AUTH></US_DOM_AUTH>
</CreateUser>

Example
Private Sub CreateUser()

'CreateUser Example
    Dim sReply As String
    sReply = m_SAClient.CreateUser _
        ("alex_td", "Alex Dashevsky", _
        "alex_td@abc.com", "301-3432778", _
        "QualityCenter_Demo", _
        "alexPassword")
    Debug.Print sReply
    MsgBox sReply
 
End Sub
See Also

SAapi Object  | SAapi Members