@keycloak/keycloak-admin-client 24.0.4 → 25.0.0

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;

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;
@@ -51,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);

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/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

@@ -77,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/userSessionRepresentation.d.ts

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

package/lib/resources/agent.js

@@ -111,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");

package/lib/resources/authenticationManagement.d.ts

@@ -7,6 +7,8 @@ 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";
+import type RequiredActionConfigInfoRepresentation from "../defs/requiredActionConfigInfoRepresentation.js";
+import type RequiredActionConfigRepresentation from "../defs/requiredActionConfigRepresentation.js";
 export declare class AuthenticationManagement extends Resource<{
     realm?: string;
 }> {
@@ -132,6 +134,26 @@ export declare class AuthenticationManagement extends Resource<{
     } & {
         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;
     } & {

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

@@ -19,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 {
@@ -97,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

@@ -77,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/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/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/users.d.ts

@@ -22,6 +22,7 @@ interface UserBaseQuery {
     firstName?: string;
     lastName?: string;
     username?: string;
+    q?: string;
 }
 export interface UserQuery extends PaginationQuery, SearchQuery, UserBaseQuery {
     exact?: boolean;
@@ -324,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keycloak/keycloak-admin-client",
-  "version": "24.0.4",
+  "version": "25.0.0",
   "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"
@@ -37,13 +37,13 @@
   },
   "devDependencies": {
     "@faker-js/faker": "^8.4.1",
-    "@types/chai": "^4.3.12",
+    "@types/chai": "^4.3.16",
     "@types/lodash-es": "^4.17.12",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.24",
-    "chai": "^5.1.0",
+    "@types/node": "^20.14.2",
+    "chai": "^5.1.1",
     "lodash-es": "^4.17.21",
-    "mocha": "^10.3.0",
+    "mocha": "^10.4.0",
     "ts-node": "^10.9.2"
   },
   "author": {
@@ -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": {