Adding a User

You can add a user with the addUser method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
email (required) string E-mail address of the new user.
password (optional) string Password of the new user. If it's not specified, the password will be generated automatically.
sendLoginEmail (optional, default: true) bool This parameter determines whether to send an e-mail to the added user.
invitationMessage (optional) string Invitation text added to the e-mail message.
groups (optional) string[] An array with group IDs, to which a user will be added.

Return Value

After the request has been completed, the system returns an object with the following properties:

Parameter Type Description
userId string ID of the added user.
exceededGroups string[] an array of group IDs, to which a user hasn't been added due to the exceeded user limit.

Possible Errors

Error Description
Duplicated email a user with this e-mail address already exists
Number of user accounts is exceeded the number of user accounts supported by a given account is exceeded

Sample Call

<?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>
    <AddUserRequest xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Credentials>
        <AccountUrl>http://myaccount.ispringonline.com</EmailAddress>
        <Email>email@email.com</Password>
        <Password>password</Password>
      </Credentials>
      <Email>user@email.com</Email>
      <Password>password</Password>
      <SendLoginEmail>true</SendLoginEmail>
      <InvitationMessage>Message</InvitationMessage>
      <Groups>
        <id>1</id>
        <id>2</id>
      </Groups>
    </AddUserRequest>
  </soap:Body>
</soap:Envelope>

Sample Response

<?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>
    <AddUserResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <UserId>1<UserId>
      <ExceededGroups />
    </AddUserResult>
  </soap:Body>
</soap:Envelope>