xclade
Admin APIUsers

Delete a User

Delete a user.

DELETE
/admin/users/{id}

Authorization

connect.sid<token>

In: cookie

Path Parameters

id*string

The user's ID.

Response Body

application/json

application/json

text/plain

application/json

application/json

application/json

application/json

curl -X DELETE "https://{tenant}.api.myxclade.com/admin/users/string"
{
  "id": "string",
  "object": "user",
  "deleted": true
}

{
  "message": "Discount must be set to dynamic",
  "type": "not_allowed"
}

"Unauthorized"
{
  "message": "Entity with id 1 was not found",
  "type": "not_found"
}
{
  "code": "unknown_error",
  "message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
  "type": "QueryRunnerAlreadyReleasedError"
}
{
  "code": "invalid_request_error",
  "message": "Discount with code TEST already exists.",
  "type": "duplicate_error"
}

{
  "code": "api_error",
  "message": "An error occured while hashing password",
  "type": "database_error"
}

Set Authentication Session

Set the cookie session ID of an admin user. The admin must be previously authenticated with the `/auth/user/{provider}` API route first, as the JWT token is required in the header of the request.

List Users

Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated.