SOAP API - CreateUser

CreateUser( username, password, alternativeUserName, roleName, cultureName, languageName, ownerUsername, parentUsername, userStatusTypeName, creditRatingName, billGroupName, expireDate ) : Integer

Since: EngageIP v25.2

Creates a new user and associated account and returns the new user's ID or throws exception if creation of the user fails.

Parameters:

username (String) - Primary name for the user, which must be unique across the entire billing system
password (String) - Password for the new user
alternativeUserName (String) - Another name for this user, which is not required to be unique. Set to null if no alternative name is needed
roleName (String) - Name of the role to which the user will belong to. An exception will be thrown if the role does not exist.
cultureName (String) - Name of the culture which the user will belong to. An exception will be thrown if the culture does not exist
languageName (String) - Name of the language which will be used by this user. An exception will be thrown if the language does not exist
ownerUsername (String) - Name of the owner user to which the new user will belong. If specified, an exception will be thrown if the owner user does not exist.
parentUsername (String) - Name of the user which will be the parent to the new user. If this parameter is left blank or null, the new user will not have a parent.
userStatusTypeName (String) - Name of the new user's status. An exception will be thrown if the status type does not exist.
creditRatingName (String) - Name of the credit rating for the new user. An exception will be thrown if the credit rating does not exist
billGroupName (String) - Name of the bill group to which the new user will belong. An exception will be thrown if the bill group does not exist.
expireDate (DateTime) - This parameter is not used and will be eventually removed. Please pass a null value until then.

Returns:

The new user ID

Possible Exceptions:

INVALID ROLE
NVALID CULTURE
INVALID LANGUAGE
INVALID OWNER
INVALID STATUS TYPE
INVALID CREDIT RATING
INVALID BILL GROUP

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <CreateUser xmlns="Logisense_EngageIP">
      <username>string</username>
      <password>string</password>
      <alternativeUsername>string</alternativeUsername>
      <roleName>string</roleName>
      <cultureName>string</cultureName>
      <languageName>string</languageName>
      <ownerUsername>string</ownerUsername>
      <parentUsername>string</parentUsername>
      <userStatusTypeName>string</userStatusTypeName>
      <creditRatingName>string</creditRatingName>
      <billGroupName>string</billGroupName>
      <expireDate>dateTime</expireDate>
    </CreateUser>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateUserResponse xmlns="Logisense_EngageIP">
      <CreateUserResult>int</CreateUserResult>
    </CreateUserResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/CreateUser"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <CreateUser xmlns="Logisense_EngageIP">
      <username>string</username>
      <password>string</password>
      <alternativeUsername>string</alternativeUsername>
      <roleName>string</roleName>
      <cultureName>string</cultureName>
      <languageName>string</languageName>
      <ownerUsername>string</ownerUsername>
      <parentUsername>string</parentUsername>
      <userStatusTypeName>string</userStatusTypeName>
      <creditRatingName>string</creditRatingName>
      <billGroupName>string</billGroupName>
      <expireDate>dateTime</expireDate>
    </CreateUser>
  </soap:Body>
</soap:Envelope>

v9 Documentation

SOAP API - CreateUser

Related pages