@keycloak/keycloak-admin-client 25.0.3 → 25.0.4

package/README.md

@@ -53,7 +53,7 @@ const groups = await kcAdminClient.groups.find();
 
 // Set a `realm` property to override the realm for only a single operation.
 // For example, creating a user in another realm:
-await this.kcAdminClient.users.create({
+await kcAdminClient.users.create({
   realm: 'a-third-realm',
   username: 'username',
   email: 'user@example.com',
@@ -107,13 +107,13 @@ setInterval(() => kcAdminClient.auth(credentials), 58 * 1000); // 58 seconds
 To build the source do a build:
 
 ```bash
-pnpm run build
+pnpm build
 ```
 
 Start the Keycloak server:
 
 ```bash
-pnpm run server:start
+pnpm server:start
 ```
 
 If you started your container manually make sure there is an admin user named 'admin' with password 'admin'.

package/lib/client.d.ts

@@ -9,6 +9,7 @@ import { Components } from "./resources/components.js";
 import { Groups } from "./resources/groups.js";
 import { IdentityProviders } from "./resources/identityProviders.js";
 import { Realms } from "./resources/realms.js";
+import { Organizations } from "./resources/organizations.js";
 import { Roles } from "./resources/roles.js";
 import { ServerInfo } from "./resources/serverInfo.js";
 import { Users } from "./resources/users.js";
@@ -30,6 +31,7 @@ export declare class KeycloakAdminClient {
     userStorageProvider: UserStorageProvider;
     groups: Groups;
     roles: Roles;
+    organizations: Organizations;
     clients: Clients;
     realms: Realms;
     clientScopes: ClientScopes;
@@ -43,6 +45,7 @@ export declare class KeycloakAdminClient {
     cache: Cache;
     baseUrl: string;
     realmName: string;
+    scope?: string;
     accessToken?: string;
     refreshToken?: string;
     constructor(connectionConfig?: ConnectionConfig);

package/lib/client.js

@@ -8,6 +8,7 @@ import { Components } from "./resources/components.js";
 import { Groups } from "./resources/groups.js";
 import { IdentityProviders } from "./resources/identityProviders.js";
 import { Realms } from "./resources/realms.js";
+import { Organizations } from "./resources/organizations.js";
 import { Roles } from "./resources/roles.js";
 import { ServerInfo } from "./resources/serverInfo.js";
 import { Users } from "./resources/users.js";
@@ -21,6 +22,7 @@ export class KeycloakAdminClient {
     userStorageProvider;
     groups;
     roles;
+    organizations;
     clients;
     realms;
     clientScopes;
@@ -35,6 +37,7 @@ export class KeycloakAdminClient {
     // Members
     baseUrl;
     realmName;
+    scope;
     accessToken;
     refreshToken;
     #requestOptions;
@@ -50,6 +53,7 @@ export class KeycloakAdminClient {
         this.userStorageProvider = new UserStorageProvider(this);
         this.groups = new Groups(this);
         this.roles = new Roles(this);
+        this.organizations = new Organizations(this);
         this.clients = new Clients(this);
         this.realms = new Realms(this);
         this.clientScopes = new ClientScopes(this);
@@ -66,6 +70,7 @@ export class KeycloakAdminClient {
         const { accessToken, refreshToken } = await getToken({
             baseUrl: this.baseUrl,
             realmName: this.realmName,
+            scope: this.scope,
             credentials,
             requestOptions: this.#requestOptions,
         });

package/lib/defs/authenticatorConfigRepresentation.d.ts

@@ -12,4 +12,5 @@ export interface AuthenticationProviderRepresentation {
     id?: string;
     displayName?: string;
     description?: string;
+    supportsSecret?: boolean;
 }

package/lib/defs/clientPoliciesRepresentation.d.ts

@@ -3,5 +3,6 @@ import type ClientPolicyRepresentation from "./clientPolicyRepresentation.js";
  * https://www.keycloak.org/docs-api/15.0/rest-api/#_clientpoliciesrepresentation
  */
 export default interface ClientPoliciesRepresentation {
+    globalPolicies?: ClientPolicyRepresentation[];
     policies?: ClientPolicyRepresentation[];
 }

package/lib/defs/effectiveMessageBundleRepresentation.d.ts

@@ -1,6 +1,5 @@
 export default interface EffectiveMessageBundleRepresentation {
-    theme?: string;
-    themeType?: string;
-    locale?: string;
-    source?: boolean;
+    key: string;
+    value: string;
+    source: "THEME" | "REALM";
 }

package/lib/defs/organizationDomainRepresentation.d.ts

@@ -0,0 +1,4 @@
+export default interface OrganizationDomainRepresentation {
+    name?: string;
+    verified?: boolean;
+}

package/lib/defs/organizationDomainRepresentation.js

@@ -0,0 +1 @@
+export {};

package/lib/defs/organizationRepresentation.d.ts

@@ -0,0 +1,9 @@
+import type OrganizationDomainRepresentation from "./organizationDomainRepresentation.js";
+export default interface OrganizationRepresentation {
+    id?: string;
+    name?: string;
+    description?: string;
+    enabled?: boolean;
+    attributes?: Record<string, string[]>;
+    domains?: OrganizationDomainRepresentation[];
+}

package/lib/defs/organizationRepresentation.js

@@ -0,0 +1 @@
+export {};

package/lib/defs/realmRepresentation.d.ts

@@ -69,6 +69,7 @@ export default interface RealmRepresentation {
     loginWithEmailAllowed?: boolean;
     maxDeltaTimeSeconds?: number;
     maxFailureWaitSeconds?: number;
+    maxTemporaryLockouts?: number;
     minimumQuickLoginWaitSeconds?: number;
     notBefore?: number;
     oauth2DeviceCodeLifespan?: number;
@@ -76,6 +77,7 @@ export default interface RealmRepresentation {
     offlineSessionIdleTimeout?: number;
     offlineSessionMaxLifespan?: number;
     offlineSessionMaxLifespanEnabled?: boolean;
+    organizationsEnabled?: boolean;
     otpPolicyAlgorithm?: string;
     otpPolicyDigits?: number;
     otpPolicyInitialCounter?: number;

package/lib/defs/requiredActionConfigInfoRepresentation.d.ts

@@ -0,0 +1,4 @@
+import { ConfigPropertyRepresentation } from "./configPropertyRepresentation.js";
+export default interface RequiredActionConfigInfoRepresentation {
+    properties?: ConfigPropertyRepresentation[];
+}

package/lib/defs/requiredActionConfigInfoRepresentation.js

@@ -0,0 +1 @@
+export {};

package/lib/defs/requiredActionConfigRepresentation.d.ts

@@ -0,0 +1,5 @@
+export default interface RequiredActionConfigRepresentation {
+    config?: {
+        [index: string]: string;
+    };
+}

package/lib/defs/requiredActionConfigRepresentation.js

@@ -0,0 +1 @@
+export {};

package/lib/defs/userProfileMetadata.d.ts

@@ -1,6 +1,7 @@
-export default interface UserProfileConfig {
+export interface UserProfileConfig {
     attributes?: UserProfileAttribute[];
     groups?: UserProfileGroup[];
+    unmanagedAttributePolicy?: UnmanagedAttributePolicy;
 }
 export interface UserProfileAttribute {
     name?: string;
@@ -13,6 +14,7 @@ export interface UserProfileAttribute {
     selector?: UserProfileAttributeSelector;
     displayName?: string;
     group?: string;
+    multivalued?: boolean;
 }
 export interface UserProfileAttributeRequired {
     roles?: string[];
@@ -39,6 +41,7 @@ export interface UserProfileAttributeMetadata {
     group?: string;
     annotations?: Record<string, unknown>;
     validators?: Record<string, Record<string, unknown>>;
+    multivalued?: boolean;
 }
 export interface UserProfileAttributeGroupMetadata {
     name?: string;
@@ -50,3 +53,9 @@ export interface UserProfileMetadata {
     attributes?: UserProfileAttributeMetadata[];
     groups?: UserProfileAttributeGroupMetadata[];
 }
+export declare enum UnmanagedAttributePolicy {
+    Disabled = "DISABLED",
+    Enabled = "ENABLED",
+    AdminView = "ADMIN_VIEW",
+    AdminEdit = "ADMIN_EDIT"
+}

package/lib/defs/userProfileMetadata.js

@@ -1 +1,7 @@
-export {};
+export var UnmanagedAttributePolicy;
+(function (UnmanagedAttributePolicy) {
+    UnmanagedAttributePolicy["Disabled"] = "DISABLED";
+    UnmanagedAttributePolicy["Enabled"] = "ENABLED";
+    UnmanagedAttributePolicy["AdminView"] = "ADMIN_VIEW";
+    UnmanagedAttributePolicy["AdminEdit"] = "ADMIN_EDIT";
+})(UnmanagedAttributePolicy || (UnmanagedAttributePolicy = {}));

package/lib/defs/userSessionRepresentation.d.ts

@@ -6,4 +6,5 @@ export default interface UserSessionRepresentation {
     start?: number;
     userId?: string;
     username?: string;
+    transientUser?: boolean;
 }

package/lib/resources/agent.js

@@ -1,10 +1,11 @@
-import { isUndefined, last, omit, pick } from "lodash-es";
 import urlJoin from "url-join";
 import { parseTemplate } from "url-template";
 import { fetchWithError, NetworkError, parseResponse, } from "../utils/fetchWithError.js";
 import { stringifyQueryParams } from "../utils/stringifyQueryParams.js";
 // constants
 const SLASH = "/";
+const pick = (value, keys) => Object.fromEntries(Object.entries(value).filter(([key]) => keys.includes(key)));
+const omit = (value, keys) => Object.fromEntries(Object.entries(value).filter(([key]) => !keys.includes(key)));
 export class Agent {
     #client;
     #basePath;
@@ -20,7 +21,9 @@ export class Agent {
         return async (payload = {}, options) => {
             const baseParams = this.#getBaseParams?.() ?? {};
             // Filter query parameters by queryParamKeys
-            const queryParams = queryParamKeys.length > 0 ? pick(payload, queryParamKeys) : undefined;
+            const queryParams = queryParamKeys.length > 0
+                ? pick(payload, queryParamKeys)
+                : undefined;
             // Add filtered payload parameters to base parameters
             const allUrlParamKeys = [...Object.keys(baseParams), ...urlParamKeys];
             const urlParams = { ...baseParams, ...pick(payload, allUrlParamKeys) };
@@ -108,7 +111,10 @@ export class Agent {
         }
         else {
             // Otherwise assume it's JSON and stringify it.
-            requestOptions.body = JSON.stringify(payloadKey ? payload[payloadKey] : payload);
+            requestOptions.body =
+                payloadKey && typeof payload[payloadKey] === "string"
+                    ? payload[payloadKey]
+                    : JSON.stringify(payloadKey ? payload[payloadKey] : payload);
         }
         if (!requestHeaders.has("content-type") && !(payload instanceof FormData)) {
             requestHeaders.set("content-type", "application/json");
@@ -132,7 +138,7 @@ export class Agent {
                 if (typeof locationHeader !== "string") {
                     throw new Error(`location header is not found in request: ${res.url}`);
                 }
-                const resourceId = last(locationHeader.split(SLASH));
+                const resourceId = locationHeader.split(SLASH).pop();
                 if (!resourceId) {
                     // throw an error to let users know the response is not expected
                     throw new Error(`resourceId is not found in Location header from request: ${res.url}`);
@@ -161,8 +167,7 @@ export class Agent {
             return;
         }
         Object.keys(keyMapping).some((key) => {
-            if (isUndefined(payload[key])) {
-                // Skip if undefined
+            if (typeof payload[key] === "undefined") {
                 return false;
             }
             const newKey = keyMapping[key];

package/lib/resources/authenticationManagement.d.ts

@@ -7,87 +7,173 @@ import type AuthenticatorConfigRepresentation from "../defs/authenticatorConfigR
 import type { AuthenticationProviderRepresentation } from "../defs/authenticatorConfigRepresentation.js";
 import type AuthenticatorConfigInfoRepresentation from "../defs/authenticatorConfigInfoRepresentation.js";
 import type RequiredActionProviderSimpleRepresentation from "../defs/requiredActionProviderSimpleRepresentation.js";
-export declare class AuthenticationManagement extends Resource {
+import type RequiredActionConfigInfoRepresentation from "../defs/requiredActionConfigInfoRepresentation.js";
+import type RequiredActionConfigRepresentation from "../defs/requiredActionConfigRepresentation.js";
+export declare class AuthenticationManagement extends Resource<{
+    realm?: string;
+}> {
     /**
      * Authentication Management
      * https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_authentication_management_resource
      */
-    registerRequiredAction: (payload?: Record<string, any> | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    getRequiredActions: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderRepresentation[]>;
-    getRequiredActionForAlias: (payload?: {
+    registerRequiredAction: (payload?: (Record<string, any> & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    getRequiredActions: (payload?: (void & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderRepresentation[]>;
+    getRequiredActionForAlias: (payload?: ({
         alias: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    getClientAuthenticatorProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
-    getAuthenticatorProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
-    getFormActionProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    getClientAuthenticatorProviders: (payload?: (void & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
+    getAuthenticatorProviders: (payload?: (void & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
+    getFormActionProviders: (payload?: (void & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
     updateRequiredAction: (query: {
         alias: string;
+    } & {
+        realm?: string | undefined;
     }, payload: RequiredActionProviderRepresentation) => Promise<void>;
-    deleteRequiredAction: (payload?: {
+    deleteRequiredAction: (payload?: ({
         alias: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
-    lowerRequiredActionPriority: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
+    lowerRequiredActionPriority: (payload?: ({
         alias: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    raiseRequiredActionPriority: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    raiseRequiredActionPriority: (payload?: ({
         alias: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    getUnregisteredRequiredActions: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderSimpleRepresentation[]>;
-    getFlows: (payload?: {} | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation[]>;
-    getFlow: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    getUnregisteredRequiredActions: (payload?: (void & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderSimpleRepresentation[]>;
+    getFlows: (payload?: {
+        realm?: string | undefined;
+    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation[]>;
+    getFlow: (payload?: ({
         flowId: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
-    getFormProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
-    createFlow: (payload?: AuthenticationFlowRepresentation | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
-    copyFlow: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
+    getFormProviders: (payload?: (void & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
+    createFlow: (payload?: (AuthenticationFlowRepresentation & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
+    copyFlow: (payload?: ({
         flow: string;
         newName: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    deleteFlow: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    deleteFlow: (payload?: ({
         flowId: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
     updateFlow: (query: {
         flowId: string;
+    } & {
+        realm?: string | undefined;
     }, payload: AuthenticationFlowRepresentation) => Promise<any>;
-    getExecutions: (payload?: {
+    getExecutions: (payload?: ({
         flow: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation[]>;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation[]>;
     addExecution: (query: {
         flow: string;
+    } & {
+        realm?: string | undefined;
     }, payload: AuthenticationExecutionInfoRepresentation) => Promise<any>;
-    addExecutionToFlow: (payload?: {
+    addExecutionToFlow: (payload?: ({
         flow: string;
         provider: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation>;
-    addFlowToFlow: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation>;
+    addFlowToFlow: (payload?: ({
         flow: string;
         alias: string;
         type: string;
         provider: string;
         description: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
     updateExecution: (query: {
         flow: string;
+    } & {
+        realm?: string | undefined;
     }, payload: AuthenticationExecutionInfoRepresentation) => Promise<any>;
-    delExecution: (payload?: {
+    delExecution: (payload?: ({
         id: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    lowerPriorityExecution: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    lowerPriorityExecution: (payload?: ({
         id: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    raisePriorityExecution: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    raisePriorityExecution: (payload?: ({
         id: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
-    getConfigDescription: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    getRequiredActionConfigDescription: (payload?: ({
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionConfigInfoRepresentation>;
+    getRequiredActionConfig: (payload?: ({
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionConfigRepresentation>;
+    removeRequiredActionConfig: (payload?: ({
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    updateRequiredActionConfig: (query: {
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }, payload: RequiredActionConfigRepresentation) => Promise<void>;
+    getConfigDescription: (payload?: ({
         providerId: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigInfoRepresentation>;
-    createConfig: (payload?: AuthenticatorConfigRepresentation | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
-    updateConfig: (payload?: AuthenticatorConfigRepresentation | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
-    getConfig: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigInfoRepresentation>;
+    createConfig: (payload?: (AuthenticatorConfigRepresentation & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
+    updateConfig: (payload?: (AuthenticatorConfigRepresentation & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
+    getConfig: (payload?: ({
         id: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
-    delConfig: (payload?: {
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
+    delConfig: (payload?: ({
         id: string;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
     constructor(client: KeycloakAdminClient);
 }

package/lib/resources/authenticationManagement.js

@@ -137,6 +137,30 @@ export class AuthenticationManagement extends Resource {
         path: "/executions/{id}/raise-priority",
         urlParamKeys: ["id"],
     });
+    // Get required actions provider's configuration description
+    getRequiredActionConfigDescription = this.makeRequest({
+        method: "GET",
+        path: "/required-actions/{alias}/config-description",
+        urlParamKeys: ["alias"],
+    });
+    // Get the configuration of the RequiredAction provider in the current Realm.
+    getRequiredActionConfig = this.makeRequest({
+        method: "GET",
+        path: "/required-actions/{alias}/config",
+        urlParamKeys: ["alias"],
+    });
+    // Remove the configuration from the RequiredAction provider in the current Realm.
+    removeRequiredActionConfig = this.makeRequest({
+        method: "DELETE",
+        path: "/required-actions/{alias}/config",
+        urlParamKeys: ["alias"],
+    });
+    // Update the configuration from the RequiredAction provider in the current Realm.
+    updateRequiredActionConfig = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/required-actions/{alias}/config",
+        urlParamKeys: ["alias"],
+    });
     getConfigDescription = this.makeRequest({
         method: "GET",
         path: "config-description/{providerId}",

package/lib/resources/clientPolicies.d.ts

@@ -17,9 +17,11 @@ export declare class ClientPolicies extends Resource<{
     createProfiles: (payload?: (ClientProfilesRepresentation & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
-    listPolicies: (payload?: {
+    listPolicies: (payload?: ({
+        includeGlobalPolicies?: boolean | undefined;
+    } & {
         realm?: string | undefined;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ClientPoliciesRepresentation>;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ClientPoliciesRepresentation>;
     updatePolicy: (payload?: (ClientPoliciesRepresentation & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;

package/lib/resources/clientPolicies.js

@@ -29,6 +29,10 @@ export class ClientPolicies extends Resource {
     listPolicies = this.makeRequest({
         method: "GET",
         path: "/policies",
+        queryParamKeys: ["include-global-policies"],
+        keyTransform: {
+            includeGlobalPolicies: "include-global-policies",
+        },
     });
     updatePolicy = this.makeRequest({
         method: "PUT",

package/lib/resources/clients.d.ts

@@ -27,6 +27,7 @@ export interface ClientQuery extends PaginatedQuery {
     clientId?: string;
     viewableOnly?: boolean;
     search?: boolean;
+    q?: string;
 }
 export interface ResourceQuery extends PaginatedQuery {
     id?: string;
@@ -93,7 +94,7 @@ export declare class Clients extends Resource<{
         roleName: string;
     } & {
         realm?: string | undefined;
-    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation>;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation | null>;
     updateRole: (query: {
         id: string;
         roleName: string;

package/lib/resources/groups.d.ts

@@ -7,6 +7,7 @@ import type { RoleMappingPayload } from "../defs/roleRepresentation.js";
 import type UserRepresentation from "../defs/userRepresentation.js";
 import Resource from "./resource.js";
 interface Query {
+    q?: string;
     search?: string;
     exact?: boolean;
 }
@@ -18,7 +19,7 @@ interface SummarizedQuery {
     briefRepresentation?: boolean;
 }
 export type GroupQuery = Query & PaginatedQuery & SummarizedQuery;
-export type SubGroupQuery = PaginatedQuery & SummarizedQuery & {
+export type SubGroupQuery = Query & PaginatedQuery & SummarizedQuery & {
     parentId: string;
 };
 export interface GroupCountQuery {
@@ -96,7 +97,7 @@ export declare class Groups extends Resource<{
     /**
      * Finds all subgroups on the specified parent group matching the provided parameters.
      */
-    listSubGroups: (payload?: (PaginatedQuery & SummarizedQuery & {
+    listSubGroups: (payload?: (Query & PaginatedQuery & SummarizedQuery & {
         parentId: string;
     } & {
         realm?: string | undefined;

package/lib/resources/groups.js

@@ -2,7 +2,14 @@ import Resource from "./resource.js";
 export class Groups extends Resource {
     find = this.makeRequest({
         method: "GET",
-        queryParamKeys: ["search", "exact", "briefRepresentation", "first", "max"],
+        queryParamKeys: [
+            "search",
+            "q",
+            "exact",
+            "briefRepresentation",
+            "first",
+            "max",
+        ],
     });
     create = this.makeRequest({
         method: "POST",
@@ -70,7 +77,7 @@ export class Groups extends Resource {
         method: "GET",
         path: "/{parentId}/children",
         urlParamKeys: ["parentId"],
-        queryParamKeys: ["first", "max", "briefRepresentation"],
+        queryParamKeys: ["search", "first", "max", "briefRepresentation"],
         catchNotFound: true,
     });
     /**

package/lib/resources/identityProviders.d.ts

@@ -4,6 +4,13 @@ import type { IdentityProviderMapperTypeRepresentation } from "../defs/identityP
 import type IdentityProviderRepresentation from "../defs/identityProviderRepresentation.js";
 import type { ManagementPermissionReference } from "../defs/managementPermissionReference.js";
 import Resource from "./resource.js";
+export interface PaginatedQuery {
+    first?: number;
+    max?: number;
+}
+export interface IdentityProvidersQuery extends PaginatedQuery {
+    search?: string;
+}
 export declare class IdentityProviders extends Resource<{
     realm?: string;
 }> {
@@ -11,9 +18,9 @@ export declare class IdentityProviders extends Resource<{
      * Identity provider
      * https://www.keycloak.org/docs-api/11.0/rest-api/#_identity_providers_resource
      */
-    find: (payload?: {
+    find: (payload?: (IdentityProvidersQuery & {
         realm?: string | undefined;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;
     create: (payload?: (IdentityProviderRepresentation & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<{
@@ -91,5 +98,10 @@ export declare class IdentityProviders extends Resource<{
     } & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ManagementPermissionReference>;
+    reloadKeys: (payload?: ({
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<boolean>;
     constructor(client: KeycloakAdminClient);
 }

package/lib/resources/identityProviders.js

@@ -81,6 +81,11 @@ export class IdentityProviders extends Resource {
         path: "/instances/{alias}/management/permissions",
         urlParamKeys: ["alias"],
     });
+    reloadKeys = this.makeRequest({
+        method: "GET",
+        path: "/instances/{alias}/reload-keys",
+        urlParamKeys: ["alias"],
+    });
     constructor(client) {
         super(client, {
             path: "/admin/realms/{realm}/identity-provider",

package/lib/resources/organizations.d.ts

@@ -0,0 +1,86 @@
+import type { KeycloakAdminClient } from "../client.js";
+import IdentityProviderRepresentation from "../defs/identityProviderRepresentation.js";
+import type OrganizationRepresentation from "../defs/organizationRepresentation.js";
+import UserRepresentation from "../defs/userRepresentation.js";
+import Resource from "./resource.js";
+interface PaginatedQuery {
+    first?: number;
+    max?: number;
+    search?: string;
+}
+export interface OrganizationQuery extends PaginatedQuery {
+    q?: string;
+    exact?: boolean;
+}
+interface MemberQuery extends PaginatedQuery {
+    orgId: string;
+}
+export declare class Organizations extends Resource<{
+    realm?: string;
+}> {
+    /**
+     * Organizations
+     */
+    constructor(client: KeycloakAdminClient);
+    find: (payload?: (OrganizationQuery & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<OrganizationRepresentation[]>;
+    findOne: (payload?: ({
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<OrganizationRepresentation>;
+    create: (payload?: (OrganizationRepresentation & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<{
+        id: string;
+    }>;
+    delById: (payload?: ({
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
+    updateById: (query: {
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }, payload: OrganizationRepresentation) => Promise<void>;
+    listMembers: (payload?: (MemberQuery & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<UserRepresentation[]>;
+    addMember: (payload?: ({
+        orgId: string;
+        userId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<string>;
+    delMember: (payload?: ({
+        orgId: string;
+        userId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<string>;
+    invite: (query: {
+        orgId: string;
+    } & {
+        realm?: string | undefined;
+    }, payload: FormData) => Promise<any>;
+    listIdentityProviders: (payload?: ({
+        orgId: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;
+    linkIdp: (payload?: ({
+        orgId: string;
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<string>;
+    unLinkIdp: (payload?: ({
+        orgId: string;
+        alias: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<string>;
+}
+export {};

package/lib/resources/organizations.js

@@ -0,0 +1,76 @@
+import Resource from "./resource.js";
+export class Organizations extends Resource {
+    /**
+     * Organizations
+     */
+    constructor(client) {
+        super(client, {
+            path: "/admin/realms/{realm}/organizations",
+            getUrlParams: () => ({
+                realm: client.realmName,
+            }),
+            getBaseUrl: () => client.baseUrl,
+        });
+    }
+    find = this.makeRequest({
+        method: "GET",
+        path: "/",
+    });
+    findOne = this.makeRequest({
+        method: "GET",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    create = this.makeRequest({
+        method: "POST",
+        path: "/",
+        returnResourceIdInLocationHeader: { field: "id" },
+    });
+    delById = this.makeRequest({
+        method: "DELETE",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    updateById = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    listMembers = this.makeRequest({
+        method: "GET",
+        path: "/{orgId}/members",
+        urlParamKeys: ["orgId"],
+    });
+    addMember = this.makeRequest({
+        method: "POST",
+        path: "/{orgId}/members",
+        urlParamKeys: ["orgId"],
+        payloadKey: "userId",
+    });
+    delMember = this.makeRequest({
+        method: "DELETE",
+        path: "/{orgId}/members/{userId}",
+        urlParamKeys: ["orgId", "userId"],
+    });
+    invite = this.makeUpdateRequest({
+        method: "POST",
+        path: "/{orgId}/members/invite-user",
+        urlParamKeys: ["orgId"],
+    });
+    listIdentityProviders = this.makeRequest({
+        method: "GET",
+        path: "/{orgId}/identity-providers",
+        urlParamKeys: ["orgId"],
+    });
+    linkIdp = this.makeRequest({
+        method: "POST",
+        path: "/{orgId}/identity-providers",
+        urlParamKeys: ["orgId"],
+        payloadKey: "alias",
+    });
+    unLinkIdp = this.makeRequest({
+        method: "DELETE",
+        path: "/{orgId}/identity-providers/{alias}",
+        urlParamKeys: ["orgId", "alias"],
+    });
+}

package/lib/resources/realms.d.ts

@@ -146,6 +146,7 @@ export declare class Realms extends Resource {
     deleteSession: (payload?: {
         realm: string;
         session: string;
+        isOffline: boolean;
     } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
     pushRevocation: (payload?: {
         realm: string;

package/lib/resources/realms.js

@@ -177,6 +177,7 @@ export class Realms extends Resource {
         method: "DELETE",
         path: "/{realm}/sessions/{session}",
         urlParamKeys: ["realm", "session"],
+        queryParamKeys: ["isOffline"],
     });
     pushRevocation = this.makeRequest({
         method: "POST",

package/lib/resources/resource.d.ts

@@ -7,6 +7,6 @@ export default class Resource<ParamType = {}> {
         getUrlParams?: () => Record<string, any>;
         getBaseUrl?: () => string;
     });
-    makeRequest: <PayloadType = any, ResponseType_1 = any>(args: RequestArgs) => (payload?: (PayloadType & ParamType) | undefined, options?: Pick<RequestArgs, "catchNotFound">) => Promise<ResponseType_1>;
-    makeUpdateRequest: <QueryType = any, PayloadType = any, ResponseType_1 = any>(args: RequestArgs) => (query: QueryType & ParamType, payload: PayloadType) => Promise<ResponseType_1>;
+    makeRequest: <PayloadType = any, ResponseType = any>(args: RequestArgs) => ((payload?: PayloadType & ParamType, options?: Pick<RequestArgs, "catchNotFound">) => Promise<ResponseType>);
+    makeUpdateRequest: <QueryType = any, PayloadType = any, ResponseType = any>(args: RequestArgs) => ((query: QueryType & ParamType, payload: PayloadType) => Promise<ResponseType>);
 }

package/lib/resources/serverInfo.d.ts

@@ -2,14 +2,15 @@ import Resource from "./resource.js";
 import type { ServerInfoRepresentation } from "../defs/serverInfoRepesentation.js";
 import type KeycloakAdminClient from "../index.js";
 import type EffectiveMessageBundleRepresentation from "../defs/effectiveMessageBundleRepresentation.js";
+export interface MessageBundleQuery {
+    realm: string;
+    theme?: string;
+    themeType?: string;
+    locale?: string;
+    source?: boolean;
+}
 export declare class ServerInfo extends Resource {
     constructor(client: KeycloakAdminClient);
     find: (payload?: {} | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ServerInfoRepresentation>;
-    findEffectiveMessageBundles: (payload?: {
-        realm: string;
-        theme?: string | undefined;
-        themeType?: string | undefined;
-        locale?: string | undefined;
-        source?: boolean | undefined;
-    } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<EffectiveMessageBundleRepresentation[]>;
+    findEffectiveMessageBundles: (payload?: MessageBundleQuery | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<EffectiveMessageBundleRepresentation[]>;
 }

package/lib/resources/users.d.ts

@@ -6,8 +6,7 @@ import type MappingsRepresentation from "../defs/mappingsRepresentation.js";
 import type RoleRepresentation from "../defs/roleRepresentation.js";
 import type { RoleMappingPayload } from "../defs/roleRepresentation.js";
 import type UserConsentRepresentation from "../defs/userConsentRepresentation.js";
-import type UserProfileConfig from "../defs/userProfileMetadata.js";
-import type { UserProfileMetadata } from "../defs/userProfileMetadata.js";
+import type { UserProfileConfig, UserProfileMetadata } from "../defs/userProfileMetadata.js";
 import type UserRepresentation from "../defs/userRepresentation.js";
 import type UserSessionRepresentation from "../defs/userSessionRepresentation.js";
 import Resource from "./resource.js";
@@ -23,6 +22,7 @@ interface UserBaseQuery {
     firstName?: string;
     lastName?: string;
     username?: string;
+    q?: string;
 }
 export interface UserQuery extends PaginationQuery, SearchQuery, UserBaseQuery {
     exact?: boolean;
@@ -325,6 +325,11 @@ export declare class Users extends Resource<{
     } & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
+    getUnmanagedAttributes: (payload?: ({
+        id: string;
+    } & {
+        realm?: string | undefined;
+    }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<Record<string, string[]>>;
     constructor(client: KeycloakAdminClient);
 }
 export {};

package/lib/resources/users.js

@@ -283,6 +283,11 @@ export class Users extends Resource {
         path: "/{id}/consents/{clientId}",
         urlParamKeys: ["id", "clientId"],
     });
+    getUnmanagedAttributes = this.makeRequest({
+        method: "GET",
+        path: "/{id}/unmanagedAttributes",
+        urlParamKeys: ["id"],
+    });
     constructor(client) {
         super(client, {
             path: "/admin/realms/{realm}/users",

package/lib/utils/auth.d.ts

@@ -13,6 +13,7 @@ export interface Credentials {
 export interface Settings {
     realmName?: string;
     baseUrl?: string;
+    scope?: string;
     credentials: Credentials;
     requestOptions?: RequestInit;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keycloak/keycloak-admin-client",
-  "version": "25.0.3",
+  "version": "25.0.4",
   "description": "A client to interact with Keycloak's Administration API",
   "type": "module",
   "main": "lib/index.js",
@@ -24,7 +24,7 @@
       ]
     },
     "lint": {
-      "command": "eslint . --ext js,jsx,mjs,ts,tsx"
+      "command": "eslint ."
     },
     "test": {
       "command": "TS_NODE_PROJECT=tsconfig.test.json mocha --recursive \"test/**/*.spec.ts\" --timeout 10000"
@@ -32,19 +32,19 @@
   },
   "dependencies": {
     "camelize-ts": "^3.0.0",
-    "lodash-es": "^4.17.21",
     "url-join": "^5.0.0",
-    "url-template": "^3.1.0"
+    "url-template": "^3.1.1"
   },
   "devDependencies": {
-    "@faker-js/faker": "^8.3.1",
-    "@types/chai": "^4.3.11",
+    "@faker-js/faker": "^8.4.1",
+    "@types/chai": "^4.3.16",
     "@types/lodash-es": "^4.17.12",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.9.4",
-    "chai": "^4.3.10",
-    "mocha": "^10.2.0",
-    "ts-node": "^10.9.1"
+    "@types/node": "^20.14.2",
+    "chai": "^5.1.1",
+    "lodash-es": "^4.17.21",
+    "mocha": "^10.4.0",
+    "ts-node": "^10.9.2"
   },
   "author": {
     "name": "Red Hat, Inc.",
@@ -53,7 +53,8 @@
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/keycloak/keycloak.git"
+    "url": "https://github.com/keycloak/keycloak.git",
+    "directory": "js/libs/keycloak-admin-client"
   },
   "homepage": "https://www.keycloak.org/",
   "scripts": {