import Resource from "./resource.js"; import type AdminEventRepresentation from "../defs/adminEventRepresentation.js"; import type RealmRepresentation from "../defs/realmRepresentation.js"; import type { PartialImportRealmRepresentation, PartialImportResponse } from "../defs/realmRepresentation.js"; import type EventRepresentation from "../defs/eventRepresentation.js"; import type EventType from "../defs/eventTypes.js"; import type KeysMetadataRepresentation from "../defs/keyMetadataRepresentation.js"; import type ClientInitialAccessPresentation from "../defs/clientInitialAccessPresentation.js"; import type TestLdapConnectionRepresentation from "../defs/testLdapConnection.js"; import type { KeycloakAdminClient } from "../client.js"; import type { RealmEventsConfigRepresentation } from "../defs/realmEventsConfigRepresentation.js"; import type GlobalRequestResult from "../defs/globalRequestResult.js"; import type GroupRepresentation from "../defs/groupRepresentation.js"; import type { ManagementPermissionReference } from "../defs/managementPermissionReference.js"; import type ComponentTypeRepresentation from "../defs/componentTypeRepresentation.js"; import type { ClientSessionStat } from "../defs/clientSessionStat.js"; export declare class Realms extends Resource { /** * Realm * https://www.keycloak.org/docs-api/11.0/rest-api/#_realms_admin_resource */ find: (payload?: { briefRepresentation?: boolean; } | undefined, options?: Pick) => Promise; create: (payload?: RealmRepresentation | undefined, options?: Pick) => Promise<{ realmName: string; }>; findOne: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; update: (query: { realm: string; }, payload: RealmRepresentation) => Promise; del: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; partialImport: (payload?: { realm: string; rep: PartialImportRealmRepresentation; } | undefined, options?: Pick) => Promise; export: (payload?: { realm: string; exportClients?: boolean; exportGroupsAndRoles?: boolean; } | undefined, options?: Pick) => Promise; getDefaultGroups: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; addDefaultGroup: (payload?: { realm: string; id: string; } | undefined, options?: Pick) => Promise; removeDefaultGroup: (payload?: { realm: string; id: string; } | undefined, options?: Pick) => Promise; getGroupByPath: (payload?: { path: string; realm: string; } | undefined, options?: Pick) => Promise; /** * Get events Returns all events, or filters them based on URL query parameters listed here */ findEvents: (payload?: { realm: string; client?: string; dateFrom?: string; dateTo?: string; first?: number; ipAddress?: string; max?: number; type?: EventType | EventType[]; user?: string; } | undefined, options?: Pick) => Promise; getConfigEvents: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; updateConfigEvents: (query: { realm: string; }, payload: RealmEventsConfigRepresentation) => Promise; clearEvents: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; clearAdminEvents: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; getClientRegistrationPolicyProviders: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; getClientsInitialAccess: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; createClientsInitialAccess: (query: { realm: string; }, payload: { count?: number; expiration?: number; }) => Promise; delClientsInitialAccess: (payload?: { realm: string; id: string; } | undefined, options?: Pick) => Promise; /** * Remove a specific user session. */ removeSession: (payload?: { realm: string; sessionId: string; } | undefined, options?: Pick) => Promise; /** * Get admin events Returns all admin events, or filters events based on URL query parameters listed here */ findAdminEvents: (payload?: { realm: string; authClient?: string; authIpAddress?: string; authRealm?: string; authUser?: string; dateFrom?: Date; dateTo?: Date; first?: number; max?: number; operationTypes?: string; resourcePath?: string; resourceTypes?: string; } | undefined, options?: Pick) => Promise; /** * Users management permissions */ getUsersManagementPermissions: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; updateUsersManagementPermissions: (payload?: { realm: string; enabled: boolean; } | undefined, options?: Pick) => Promise; /** * Sessions */ getClientSessionStats: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; logoutAll: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; deleteSession: (payload?: { realm: string; session: string; isOffline: boolean; } | undefined, options?: Pick) => Promise; pushRevocation: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; getKeys: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; testLDAPConnection: (query: { realm: string; }, payload: TestLdapConnectionRepresentation) => Promise; testSMTPConnection: (query: { realm: string; }, payload: Record) => Promise; ldapServerCapabilities: (query: { realm: string; }, payload: TestLdapConnectionRepresentation) => Promise; getRealmSpecificLocales: (payload?: { realm: string; } | undefined, options?: Pick) => Promise; getRealmLocalizationTexts: (payload?: { realm: string; selectedLocale: string; first?: number; max?: number; } | undefined, options?: Pick) => Promise>; addLocalization: (query: { realm: string; selectedLocale: string; key: string; }, payload: string) => Promise; deleteRealmLocalizationTexts: (payload?: { realm: string; selectedLocale: string; key?: string; } | undefined, options?: Pick) => Promise; constructor(client: KeycloakAdminClient); }