The delete user operation will delete one user with the specified parameters.
Request
Request URI
| Method | Request URI |
|---|---|
| Delete | https://{company-name}.helloid.com/api/v1/users/{username} |
| Delete | https://{company-name}.helloid.com/api/v1/users/{userGuid} |
| Delete | https://{company-name}.helloid.com/api/v1/users/{adsid} |
| Delete | https://{company-name}.helloid.com/api/v1/users/{userId} |
Request parameters
| Parameters | Description |
|---|---|
| {company-name} | The company name of the target company |
| {username} | The user name of the user you want to delete |
| {userGuid} | The user guid of the user you want to delete |
| {adsid} | The SID of the user you want to delete |
| {userId} | The user id of the user you want to delete. |
Request headers
| Header | Description |
|---|---|
| Content-Type | Required. Must be set to application/json |
Request body
None
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
Please also see common HTTP status codes.
Sample response body
None.
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X DELETE https://{company-name}.helloid.com/api/v1/users/{username}