AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: RemoveUserFromGroups
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Department Administrators and users with a custom role can delete users belonging to the departments they manage and their sub-departments.
Parameters
Parameter | Type | Description |
---|
token (required) | string | Access token. You can obtain a token by making a request. |
userId (required) | string | The ID of the user you want to delete. |
Return Value
When a request is processed successfully, the system returns an object with the following properties:
Parameter | Type | Description |
---|
success | bool | True if the user has been deleted |
Possible Errors
Error | Description |
---|
Unknown user | The user with the given ID cannot be found. |
Permission Denied | No permissions to delete the specified user |
Sample Call
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:RemoveUserFromGroupsRequest>
<soap:credentials>
<soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE</soap:token>
</soap:credentials>
<soap:userId>6c45a8ca-c0ae-11ec-89d5-0242c0a8a039</soap:userId>
<soap:groupIds>
<!--Zero or more repetitions:-->
<soap:id>c400156e-b9a6-11ec-b941-0242c0a8a039</soap:id>
<soap:id>9eebd6c0-d524-11ec-be4f-0242ac150039</soap:id>
</soap:groupIds>
</soap:RemoveUserFromGroupsRequest>
</soapenv:Body>
</soapenv:Envelope>
CODE
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>
CODE