Method: deleteUser
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 |
---|---|---|
credentials (required) | credentials | Read the description of the Credentials object. |
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
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <DeleteUserRequest> <credentials> <accountUrl>https://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="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <DeleteUserResult> <success>true</success> </DeleteUserResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>