User Storage Provider

/**
 * Get the name and ID of a user storage provider
 * @param params - Parameters containing the provider ID
 * @returns Name response with provider ID and name
 */
name(params: { id: string }): Promise<NameResponse>;

/**
 * Remove imported users from the provider
 * @param params - Parameters containing the provider ID
 * @returns void
 */
removeImportedUsers(params: { id: string }): Promise<void>;

/**
 * Synchronize users from the external storage provider
 * @param params - Parameters containing provider ID and optional action type
 * @returns Synchronization result with statistics
 */
sync(params: { id: string; action?: ActionType }): Promise<SynchronizationResultRepresentation>;

/**
 * Unlink users from the provider
 * @param params - Parameters containing the provider ID
 * @returns void
 */
unlinkUsers(params: { id: string }): Promise<void>;

/**
 * Synchronize user storage provider mappers
 * @param params - Parameters containing mapper ID, parent provider ID, and direction
 * @returns Synchronization result with statistics
 */
mappersSync(params: { 
  id: string; 
  parentId: string; 
  direction?: DirectionType 
}): Promise<SynchronizationResultRepresentation>;

import KeycloakAdminClient from "@keycloak/keycloak-admin-client";

const kcAdminClient = new KeycloakAdminClient({
  baseUrl: 'http://localhost:8080',
  realmName: 'myrealm',
});

await kcAdminClient.auth({
  username: 'admin',
  password: 'admin',
  grantType: 'password',
  clientId: 'admin-cli',
});

// Get provider information
const providerInfo = await kcAdminClient.userStorageProvider.name({
  id: 'ldap-provider-id'
});
console.log('Provider:', providerInfo.name);

// Perform full synchronization from external storage
const syncResult = await kcAdminClient.userStorageProvider.sync({
  id: 'ldap-provider-id',
  action: 'triggerFullSync'
});

console.log('Sync results:', {
  added: syncResult.added,
  updated: syncResult.updated,
  removed: syncResult.removed,
  failed: syncResult.failed
});

// Synchronize only changed users
const changedUsersSync = await kcAdminClient.userStorageProvider.sync({
  id: 'ldap-provider-id',
  action: 'triggerChangedUsersSync'
});

// Synchronize mappers from Keycloak to external storage
const mapperSync = await kcAdminClient.userStorageProvider.mappersSync({
  id: 'mapper-id',
  parentId: 'ldap-provider-id',
  direction: 'keycloakToFed'
});

// Remove imported users (they will be re-imported on next access)
await kcAdminClient.userStorageProvider.removeImportedUsers({
  id: 'ldap-provider-id'
});

// Unlink users from provider
await kcAdminClient.userStorageProvider.unlinkUsers({
  id: 'ldap-provider-id'
});

type ActionType = "triggerFullSync" | "triggerChangedUsersSync";
type DirectionType = "fedToKeycloak" | "keycloakToFed";

interface NameResponse {
  id: string;
  name: string;
}

interface SynchronizationResultRepresentation {
  status?: string;
  added?: number;
  updated?: number;
  removed?: number;
  failed?: number;
}