Removing a User from a Group

You can remove a user from a group with the removeUserFromGroup method.

Parameters

Parameter Type Description
credentials (required) credentials Read the description of the Credentials object.
groupId (required) string ID of the group, from which you want to delete the specified user.
userId (required) string ID of the user, whom you want to delete from the specified group.

Return Value

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

Parameter Type Description
success bool True, if a given user has been removed from the group.

Possible Errors

Error Description
unknown group A group with the specified ID cannot be found.
unknown user A user with the specified ID cannot be found.
user not a group’s member A given user does not belong to this group.

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>
    <RemoveUserFromGroupRequest 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>
      <UserID>string</UserID>
      <GroupID>string</GroupID>
    </RemoveUserFromGroupRequest>
  </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>
    <RemoveUserFromGroupResult xmlns="http://www.articulate-online.com/services/api/1.0/">
      <Success>True</Success>
    </RemoveUserFromGroupResult>
  </soap:Body>
</soap:Envelope>