Page tree
Skip to end of metadata
Go to start of metadata

You can delete a user with the deleteUser method.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators.

Department Administrators can delete users belonging only to the department they manage and its daughter departments.

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
userId (required)stringID of the user you want to delete.

Return Value

When a request is processed successfully, the system returns an object with the following properties:

ParameterTypeDescription
successboolTrue if the user has been deleted

Possible Errors

ErrorDescription
Unknown userThe user with the given ID cannot be found.
Permission DeniedNo permissions to delete the specified user

Sample Call

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <DeleteUserRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
      <userId>string</userId>
    </DeleteUserRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <DeleteUserResult>
      <success>true</success>
    </DeleteUserResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels