Delete a user completely, in Keycloak and logiccloud orchestrate

DELETE

/api/v1/tenant-consistency/users/{userId}

const url = 'http://localhost:3000/api/v1/tenant-consistency/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url http://localhost:3000/api/v1/tenant-consistency/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Deletes the linked Keycloak account, then the logiccloud orchestrate user row. Unlike DELETE /users/{id}, a Keycloak failure stops the delete (502) instead of leaving a Keycloak account behind. You cannot delete yourself. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Path Parameters

userId

required

string format: uuid

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

204

User deleted in both stores

400

Invalid id, or the caller’s own account

403

Forbidden - Super Admin required

404

User not found

502

Keycloak could not be read or did not delete

503

Keycloak is not configured