Clear the link between a user and their Keycloak identity

DELETE

/api/v1/users/{id}/keycloak-link

const url = 'http://localhost:3000/api/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/keycloak-link';
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/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/keycloak-link \
  --header 'X-API-Key: <X-API-Key>'

Unbinds users.keycloakId so the account can be re-linked on next sign-in, subject to the FM-837 checks. Use when a Keycloak account was legitimately re-created. Memberships and system roles are preserved. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

User UUID

Responses

204

Link cleared

400

The user has no Keycloak link to clear

401

Unauthorized

403

Forbidden - Super Admin required

404

User not found