- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Delete users
DELETE /user/{externalId}
Deleted users go to the "Trash Can"
After a /delete the user is moved to the "Trash Can" and therefore cannot be added straightaway. See Trash Can for how to recover or delete it.
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| externalId* | String | The external ID of a user that needs to be fetched. The externalID corresponds with the 'User ID' within the usermanagement. |
Sample successfull Response
{
"Success": true,
"Errors": null
}
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible errors: 102: Unknown error 202: User has not been found 260: Current user can not be deleted with external api |
| 403 | Not allowed to use external API |
| 500 | Internal server error |
Was this article helpful?