This web service deletes an internal user's account.
Method | Endpoint |
---|---|
DELETE |
/api/users/{userId} |
Path parameter | Type | Description |
---|---|---|
{userId} |
String | The user's identifier. |
This web service only fully deletes users from an internal realm. For users from an LDAP or SSO realm, the web service deletes the user's account information, but they can still sign in.
It is possible to completely remove a user from an external authentication realm by removing the user from the external authentication realm before calling this web service.
Return code | Description |
---|---|
200 OK |
The request is valid and the user's account was deleted. |
401 UNAUTHORIZED |
The authorization header was not provided or is invalid. |
403 FORBIDDEN |
The user or API key does not have the ADMIN or USERS_ADMIN role. |
404 NOT FOUND |
No user exists with this ID. |
For a comprehensive list of all possible return codes, see Return codes.