Versions Compared

Old Version 4

changes.mady.by.user Daniel Colon

Saved on

compared with

New Version Current

changes.mady.by.user Daniel Colon

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated per TFDEV-4912

/rest/{version}/users/{userId}/delete

Note

As of ThreadFix 3.8, when CoalFire Identity is enabled, user management must be performed from Coalfire Identity’s management dashboard

  • ThreadFix SaaS Customers please note when SSO is enabled, in order to restrict access to user modification, API commands are disabled at the SSO layer

Descriptor

Value

HTTP Method

DELETE

Description

Deletes user from system.

Info

To obtain the userId value in the endpoint, run the Get Users - API call first. The user's id value in the response is the userId value that you use in this endpoint.

Required Permission

Manage Users

Version Introduced

2.6.2


Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

Sample Call:

Code Block
curl -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" -X DELETE http://localhost:8080/threadfix/rest/latest/users/{userId}/delete

Sample Output:

Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "REST call to delete user is successful. User: 2"
}

Page Tree
rootwip - Users, Roles, and Groups 3.0 API