Deletes the users with the given Ids, or users matching the provided JSON query or queryString. The order of preference is Ids, query and then queryString, it is recommended to only provide one of the three for the request. This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body. Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users. OR Deactivates the users with the given Ids.

delete/api/user/bulk

Request

  • Base URL: http://localhost:9011
  • URL: http://localhost:9011/api/user/bulk
  • Auth: API key in header Authorization

Query parameters

userIdstring

The ids of the users to deactivate.

dryRunstring
hardDeletestring

Request body

dryRunboolean
hardDeleteboolean
limitinteger
querystring
queryStringstring
userIdsstring[]

Response

Success

dryRunboolean
hardDeleteboolean
totalinteger
userIdsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.