API Web Service

API

Click here for a complete list of operations.

createUsers

Create Person nodes

Test

The test form is only available for requests from the local machine.

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 /api/API.asmx HTTP/1.1
Host: secure.logmeinrescue.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://secure.logmeinrescue.com/API/API.asmx/createUsers"

<?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:Body>
    <createUsers xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <users>
        <USERDATA>
          <iUniqueId>int</iUniqueId>
          <iParentID>int</iParentID>
          <sName>string</sName>
          <sNick>string</sNick>
          <sEmail>string</sEmail>
          <sSSOID>string</sSSOID>
          <sPwd>string</sPwd>
          <sConfPwd>string</sConfPwd>
          <eStatus>Disabled or Enabled</eStatus>
          <sDescription>string</sDescription>
          <eAddOns>True or False</eAddOns>
        </USERDATA>
        <USERDATA>
          <iUniqueId>int</iUniqueId>
          <iParentID>int</iParentID>
          <sName>string</sName>
          <sNick>string</sNick>
          <sEmail>string</sEmail>
          <sSSOID>string</sSSOID>
          <sPwd>string</sPwd>
          <sConfPwd>string</sConfPwd>
          <eStatus>Disabled or Enabled</eStatus>
          <sDescription>string</sDescription>
          <eAddOns>True or False</eAddOns>
        </USERDATA>
      </users>
      <sAuthCode>string</sAuthCode>
    </createUsers>
  </soap:Body>
</soap:Envelope>

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

<?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:Body>
    <createUsersResponse xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <createUsersResult>
        <createUserInfos>
          <CREATEUSERINFO>
            <iNodeId>int</iNodeId>
            <iUniqueId>int</iUniqueId>
            <userState>createUsers_Error or createUsers_OK or createUsers_NotLoggedIn or createUsers_InvalidParam_ParentID or createUsers_InvalidParam_ParentID_Is_Zero_or_Less or createUsers_InvalidParam_Name or createUsers_InvalidParam_Email or createUsers_InvalidParam_Email_Already_In_Use or createUsers_InvalidParam_Password_Cannot_Contain_Whitespace_Characters or createUsers_InvalidParam_Password_Has_To_Be_At_Least_8_Characters_Long or createUsers_InvalidParam_Password_Has_To_Contain_At_Least_Two_Uppercase_Letters_Numbers_Or_Special_Characters or createUsers_InvalidParam_Password_Does_Not_Meet_The_Minimum_Password_Strength_Requirements or createUsers_InvalidParam_Password_New_Passwords_Do_Not_Match or createUsers_InvalidParam_Current_Password_Is_Wrong or createUsers_InvalidParam_Missing_Confirmation_Password or createUsers_Not_Enough_Seat_Licenses_Available or createUsers_Node_Cannot_Be_Enabled_Because_Its_Parent_Node_Is_Disabled or createUsers_Invalid_SecretAuthCode or createUsers_User_Deleted_Or_Disabled or createUsers_Unique_ID_Not_Unique or createUsers_Created_But_Notification_Email_Not_Sent or createUsers_Partially_Processed or createUsers_SSO_ID_Already_Exists or createUsers_InvalidParam_UniqueID_Is_Zero_or_Less or createUsers_InvalidParam_Password_Missing or createUsers_InvalidParam_Email_Missing or createUsers_InvalidParam_Nick or createUsers_InvalidParam_Description or createUsers_Unknown_Error or createUsers_Access_Denied or createUsers_EmailExisting_InAzure or createUsers_DefaultCompany_Password_Missing</userState>
          </CREATEUSERINFO>
          <CREATEUSERINFO>
            <iNodeId>int</iNodeId>
            <iUniqueId>int</iUniqueId>
            <userState>createUsers_Error or createUsers_OK or createUsers_NotLoggedIn or createUsers_InvalidParam_ParentID or createUsers_InvalidParam_ParentID_Is_Zero_or_Less or createUsers_InvalidParam_Name or createUsers_InvalidParam_Email or createUsers_InvalidParam_Email_Already_In_Use or createUsers_InvalidParam_Password_Cannot_Contain_Whitespace_Characters or createUsers_InvalidParam_Password_Has_To_Be_At_Least_8_Characters_Long or createUsers_InvalidParam_Password_Has_To_Contain_At_Least_Two_Uppercase_Letters_Numbers_Or_Special_Characters or createUsers_InvalidParam_Password_Does_Not_Meet_The_Minimum_Password_Strength_Requirements or createUsers_InvalidParam_Password_New_Passwords_Do_Not_Match or createUsers_InvalidParam_Current_Password_Is_Wrong or createUsers_InvalidParam_Missing_Confirmation_Password or createUsers_Not_Enough_Seat_Licenses_Available or createUsers_Node_Cannot_Be_Enabled_Because_Its_Parent_Node_Is_Disabled or createUsers_Invalid_SecretAuthCode or createUsers_User_Deleted_Or_Disabled or createUsers_Unique_ID_Not_Unique or createUsers_Created_But_Notification_Email_Not_Sent or createUsers_Partially_Processed or createUsers_SSO_ID_Already_Exists or createUsers_InvalidParam_UniqueID_Is_Zero_or_Less or createUsers_InvalidParam_Password_Missing or createUsers_InvalidParam_Email_Missing or createUsers_InvalidParam_Nick or createUsers_InvalidParam_Description or createUsers_Unknown_Error or createUsers_Access_Denied or createUsers_EmailExisting_InAzure or createUsers_DefaultCompany_Password_Missing</userState>
          </CREATEUSERINFO>
        </createUserInfos>
        <state>createUsers_Error or createUsers_OK or createUsers_NotLoggedIn or createUsers_InvalidParam_ParentID or createUsers_InvalidParam_ParentID_Is_Zero_or_Less or createUsers_InvalidParam_Name or createUsers_InvalidParam_Email or createUsers_InvalidParam_Email_Already_In_Use or createUsers_InvalidParam_Password_Cannot_Contain_Whitespace_Characters or createUsers_InvalidParam_Password_Has_To_Be_At_Least_8_Characters_Long or createUsers_InvalidParam_Password_Has_To_Contain_At_Least_Two_Uppercase_Letters_Numbers_Or_Special_Characters or createUsers_InvalidParam_Password_Does_Not_Meet_The_Minimum_Password_Strength_Requirements or createUsers_InvalidParam_Password_New_Passwords_Do_Not_Match or createUsers_InvalidParam_Current_Password_Is_Wrong or createUsers_InvalidParam_Missing_Confirmation_Password or createUsers_Not_Enough_Seat_Licenses_Available or createUsers_Node_Cannot_Be_Enabled_Because_Its_Parent_Node_Is_Disabled or createUsers_Invalid_SecretAuthCode or createUsers_User_Deleted_Or_Disabled or createUsers_Unique_ID_Not_Unique or createUsers_Created_But_Notification_Email_Not_Sent or createUsers_Partially_Processed or createUsers_SSO_ID_Already_Exists or createUsers_InvalidParam_UniqueID_Is_Zero_or_Less or createUsers_InvalidParam_Password_Missing or createUsers_InvalidParam_Email_Missing or createUsers_InvalidParam_Nick or createUsers_InvalidParam_Description or createUsers_Unknown_Error or createUsers_Access_Denied or createUsers_EmailExisting_InAzure or createUsers_DefaultCompany_Password_Missing</state>
      </createUsersResult>
    </createUsersResponse>
  </soap:Body>
</soap:Envelope>

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 /api/API.asmx HTTP/1.1
Host: secure.logmeinrescue.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:Body>
    <createUsers xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <users>
        <USERDATA>
          <iUniqueId>int</iUniqueId>
          <iParentID>int</iParentID>
          <sName>string</sName>
          <sNick>string</sNick>
          <sEmail>string</sEmail>
          <sSSOID>string</sSSOID>
          <sPwd>string</sPwd>
          <sConfPwd>string</sConfPwd>
          <eStatus>Disabled or Enabled</eStatus>
          <sDescription>string</sDescription>
          <eAddOns>True or False</eAddOns>
        </USERDATA>
        <USERDATA>
          <iUniqueId>int</iUniqueId>
          <iParentID>int</iParentID>
          <sName>string</sName>
          <sNick>string</sNick>
          <sEmail>string</sEmail>
          <sSSOID>string</sSSOID>
          <sPwd>string</sPwd>
          <sConfPwd>string</sConfPwd>
          <eStatus>Disabled or Enabled</eStatus>
          <sDescription>string</sDescription>
          <eAddOns>True or False</eAddOns>
        </USERDATA>
      </users>
      <sAuthCode>string</sAuthCode>
    </createUsers>
  </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>
    <createUsersResponse xmlns="https://secure.logmeinrescue.com/API/API.asmx">
      <createUsersResult>
        <createUserInfos>
          <CREATEUSERINFO>
            <iNodeId>int</iNodeId>
            <iUniqueId>int</iUniqueId>
            <userState>createUsers_Error or createUsers_OK or createUsers_NotLoggedIn or createUsers_InvalidParam_ParentID or createUsers_InvalidParam_ParentID_Is_Zero_or_Less or createUsers_InvalidParam_Name or createUsers_InvalidParam_Email or createUsers_InvalidParam_Email_Already_In_Use or createUsers_InvalidParam_Password_Cannot_Contain_Whitespace_Characters or createUsers_InvalidParam_Password_Has_To_Be_At_Least_8_Characters_Long or createUsers_InvalidParam_Password_Has_To_Contain_At_Least_Two_Uppercase_Letters_Numbers_Or_Special_Characters or createUsers_InvalidParam_Password_Does_Not_Meet_The_Minimum_Password_Strength_Requirements or createUsers_InvalidParam_Password_New_Passwords_Do_Not_Match or createUsers_InvalidParam_Current_Password_Is_Wrong or createUsers_InvalidParam_Missing_Confirmation_Password or createUsers_Not_Enough_Seat_Licenses_Available or createUsers_Node_Cannot_Be_Enabled_Because_Its_Parent_Node_Is_Disabled or createUsers_Invalid_SecretAuthCode or createUsers_User_Deleted_Or_Disabled or createUsers_Unique_ID_Not_Unique or createUsers_Created_But_Notification_Email_Not_Sent or createUsers_Partially_Processed or createUsers_SSO_ID_Already_Exists or createUsers_InvalidParam_UniqueID_Is_Zero_or_Less or createUsers_InvalidParam_Password_Missing or createUsers_InvalidParam_Email_Missing or createUsers_InvalidParam_Nick or createUsers_InvalidParam_Description or createUsers_Unknown_Error or createUsers_Access_Denied or createUsers_EmailExisting_InAzure or createUsers_DefaultCompany_Password_Missing</userState>
          </CREATEUSERINFO>
          <CREATEUSERINFO>
            <iNodeId>int</iNodeId>
            <iUniqueId>int</iUniqueId>
            <userState>createUsers_Error or createUsers_OK or createUsers_NotLoggedIn or createUsers_InvalidParam_ParentID or createUsers_InvalidParam_ParentID_Is_Zero_or_Less or createUsers_InvalidParam_Name or createUsers_InvalidParam_Email or createUsers_InvalidParam_Email_Already_In_Use or createUsers_InvalidParam_Password_Cannot_Contain_Whitespace_Characters or createUsers_InvalidParam_Password_Has_To_Be_At_Least_8_Characters_Long or createUsers_InvalidParam_Password_Has_To_Contain_At_Least_Two_Uppercase_Letters_Numbers_Or_Special_Characters or createUsers_InvalidParam_Password_Does_Not_Meet_The_Minimum_Password_Strength_Requirements or createUsers_InvalidParam_Password_New_Passwords_Do_Not_Match or createUsers_InvalidParam_Current_Password_Is_Wrong or createUsers_InvalidParam_Missing_Confirmation_Password or createUsers_Not_Enough_Seat_Licenses_Available or createUsers_Node_Cannot_Be_Enabled_Because_Its_Parent_Node_Is_Disabled or createUsers_Invalid_SecretAuthCode or createUsers_User_Deleted_Or_Disabled or createUsers_Unique_ID_Not_Unique or createUsers_Created_But_Notification_Email_Not_Sent or createUsers_Partially_Processed or createUsers_SSO_ID_Already_Exists or createUsers_InvalidParam_UniqueID_Is_Zero_or_Less or createUsers_InvalidParam_Password_Missing or createUsers_InvalidParam_Email_Missing or createUsers_InvalidParam_Nick or createUsers_InvalidParam_Description or createUsers_Unknown_Error or createUsers_Access_Denied or createUsers_EmailExisting_InAzure or createUsers_DefaultCompany_Password_Missing</userState>
          </CREATEUSERINFO>
        </createUserInfos>
        <state>createUsers_Error or createUsers_OK or createUsers_NotLoggedIn or createUsers_InvalidParam_ParentID or createUsers_InvalidParam_ParentID_Is_Zero_or_Less or createUsers_InvalidParam_Name or createUsers_InvalidParam_Email or createUsers_InvalidParam_Email_Already_In_Use or createUsers_InvalidParam_Password_Cannot_Contain_Whitespace_Characters or createUsers_InvalidParam_Password_Has_To_Be_At_Least_8_Characters_Long or createUsers_InvalidParam_Password_Has_To_Contain_At_Least_Two_Uppercase_Letters_Numbers_Or_Special_Characters or createUsers_InvalidParam_Password_Does_Not_Meet_The_Minimum_Password_Strength_Requirements or createUsers_InvalidParam_Password_New_Passwords_Do_Not_Match or createUsers_InvalidParam_Current_Password_Is_Wrong or createUsers_InvalidParam_Missing_Confirmation_Password or createUsers_Not_Enough_Seat_Licenses_Available or createUsers_Node_Cannot_Be_Enabled_Because_Its_Parent_Node_Is_Disabled or createUsers_Invalid_SecretAuthCode or createUsers_User_Deleted_Or_Disabled or createUsers_Unique_ID_Not_Unique or createUsers_Created_But_Notification_Email_Not_Sent or createUsers_Partially_Processed or createUsers_SSO_ID_Already_Exists or createUsers_InvalidParam_UniqueID_Is_Zero_or_Less or createUsers_InvalidParam_Password_Missing or createUsers_InvalidParam_Email_Missing or createUsers_InvalidParam_Nick or createUsers_InvalidParam_Description or createUsers_Unknown_Error or createUsers_Access_Denied or createUsers_EmailExisting_InAzure or createUsers_DefaultCompany_Password_Missing</state>
      </createUsersResult>
    </createUsersResponse>
  </soap12:Body>
</soap12:Envelope>