Delete user API endpoint

Updated October 20, 2020

Use this guide to to delete an end user from a Microsoft SQL Server data store through the SecureAuth Identity Management API.

To check a user status, see User status API endpoints.

Prerequisites

  1. Install SecureAuth® Identity Platform version 21.04.

  2. Complete the steps in "Prerequisites" in the Identity Management API guide.

  3. In the "Workflow" section of the Identity Management API guide, after you complete step 2, return to this document.

DELETE method

The DELETE method, when used with the deleteAllRelatedData parameter, deletes all user data from a SQL data store. The data store information, such as the user Id, password, data (first name, last name, etc.), and access history, is deleted from the following SQL tables:

  • UserTable

  • UserAccessHistory

  • UserAccessHistoryJson

  • UserFP

  • UserFPJson

  • UserOT

  • UserOTJson

  • UserPN

  • UserPNJson

SecureAuth Identity Platform accesses and deletes the specified user Id by using the username in the payload and returns a response.

HTTP Method

URI

Example

Identity Platform version

DELETE

/api/v2/users/

https://secureauth.company.com/api/v2/users/

21

Request DELETE payload

When the deleteAllRelatedData parameter is false, data is deleted from the following data table:

  • UserTable

When deleteAllRelatedData parameter is true, data is deleted from the following data tables:

  • UserAccessHistory

  • UserAccessHistoryJson

  • UserFP

  • UserFPJson

  • UserOT

  • UserOTJson

  • UserPN

  • UserPNJson

Response payload