HTTP - Management
Delete a user
Created by s.yearsley, last updated 24 Sep 2020
Deleting a user can be done by sending a DELETE request to the user resource location.
DELETE/api/security/users/{userIdentifier}
Parameter
Name | Parameter type | Type | Format | Description | Example | Required |
---|---|---|---|---|---|---|
UserIdentifier | path | string | user identifier | For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id. | "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com" | true |
Examples
Delete a user by user id
DELETE: /api/security/users/82f73a9b-2a13-4d63-bcc1-e8ee5047b01c
Delete a user by username
DELETE: /api/security/users/tdurden
Delete a user by email
DELETE: /api/security/users/t.durden@fightclub.com
Remarks
This action requires system administration privileges.