AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: terminateUsers
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can set up a multiple end of employment for the users belonging to the departments they manage and their sub-departments.
Parameters
Return Value
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|
success | bool | true if the user's status has been updated. |
Possible Errors
Type | Description |
---|
Unknown user | A user with the specified ID was not found. |
Permission denied | A user does not have enough permissions to handle the request. |
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:TerminateUsersRequest>
<soap:credentials>
<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
</soap:credentials>
<soap:userIds>
<!--Zero or more repetitions:-->
<soap:id>32bd7dc6-a7cb-11ed-b640-92a80c30e0de</soap:id>
<soap:id>887c4dfc-4806-11ed-aa3d-dec5838cbd40</soap:id>
</soap:userIds>
</soap:TerminateUsersRequest>
</soapenv:Body>
</soapenv:Envelope>
XML
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:SuccessResult>
<ns1:success>true</ns1:success>
</ns1:SuccessResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML