@keycloak/keycloak-admin-client 21.0.2 → 21.1.0

package/lib/resources/components.d.ts

@@ -1,7 +1,7 @@
-import Resource from './resource.js';
-import type ComponentRepresentation from '../defs/componentRepresentation.js';
-import type ComponentTypeRepresentation from '../defs/componentTypeRepresentation.js';
-import type { KeycloakAdminClient } from '../client.js';
+import Resource from "./resource.js";
+import type ComponentRepresentation from "../defs/componentRepresentation.js";
+import type ComponentTypeRepresentation from "../defs/componentTypeRepresentation.js";
+import type { KeycloakAdminClient } from "../client.js";
 export interface ComponentQuery {
     name?: string;
     parent?: string;
@@ -10,6 +10,10 @@ export interface ComponentQuery {
 export declare class Components extends Resource<{
     realm?: string;
 }> {
+    /**
+     * components
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_component_resource
+     */
     find: (payload?: (ComponentQuery & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ComponentRepresentation[]>;

package/lib/resources/components.js

@@ -1,42 +1,45 @@
-import Resource from './resource.js';
+import Resource from "./resource.js";
 export class Components extends Resource {
+    /**
+     * components
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_component_resource
+     */
+    find = this.makeRequest({
+        method: "GET",
+    });
+    create = this.makeRequest({
+        method: "POST",
+        returnResourceIdInLocationHeader: { field: "id" },
+    });
+    findOne = this.makeRequest({
+        method: "GET",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+        catchNotFound: true,
+    });
+    update = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    del = this.makeRequest({
+        method: "DELETE",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    listSubComponents = this.makeRequest({
+        method: "GET",
+        path: "/{id}/sub-component-types",
+        urlParamKeys: ["id"],
+        queryParamKeys: ["type"],
+    });
     constructor(client) {
         super(client, {
-            path: '/admin/realms/{realm}/components',
+            path: "/admin/realms/{realm}/components",
             getUrlParams: () => ({
                 realm: client.realmName,
             }),
             getBaseUrl: () => client.baseUrl,
         });
-        this.find = this.makeRequest({
-            method: 'GET',
-        });
-        this.create = this.makeRequest({
-            method: 'POST',
-            returnResourceIdInLocationHeader: { field: 'id' },
-        });
-        this.findOne = this.makeRequest({
-            method: 'GET',
-            path: '/{id}',
-            urlParamKeys: ['id'],
-            catchNotFound: true,
-        });
-        this.update = this.makeUpdateRequest({
-            method: 'PUT',
-            path: '/{id}',
-            urlParamKeys: ['id'],
-        });
-        this.del = this.makeRequest({
-            method: 'DELETE',
-            path: '/{id}',
-            urlParamKeys: ['id'],
-        });
-        this.listSubComponents = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/sub-component-types',
-            urlParamKeys: ['id'],
-            queryParamKeys: ['type'],
-        });
     }
 }
-//# sourceMappingURL=components.js.map

package/lib/resources/groups.d.ts

@@ -1,11 +1,11 @@
-import type { KeycloakAdminClient } from '../client.js';
-import type GroupRepresentation from '../defs/groupRepresentation.js';
-import type { ManagementPermissionReference } from '../defs/managementPermissionReference.js';
-import type MappingsRepresentation from '../defs/mappingsRepresentation.js';
-import type RoleRepresentation from '../defs/roleRepresentation.js';
-import type { RoleMappingPayload } from '../defs/roleRepresentation.js';
-import type UserRepresentation from '../defs/userRepresentation.js';
-import Resource from './resource.js';
+import type { KeycloakAdminClient } from "../client.js";
+import type GroupRepresentation from "../defs/groupRepresentation.js";
+import type { ManagementPermissionReference } from "../defs/managementPermissionReference.js";
+import type MappingsRepresentation from "../defs/mappingsRepresentation.js";
+import type RoleRepresentation from "../defs/roleRepresentation.js";
+import type { RoleMappingPayload } from "../defs/roleRepresentation.js";
+import type UserRepresentation from "../defs/userRepresentation.js";
+import Resource from "./resource.js";
 export interface GroupQuery {
     first?: number;
     max?: number;
@@ -27,6 +27,9 @@ export declare class Groups extends Resource<{
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<{
         id: string;
     }>;
+    /**
+     * Single user
+     */
     findOne: (payload?: ({
         id: string;
     } & {
@@ -47,6 +50,10 @@ export declare class Groups extends Resource<{
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<{
         count: number;
     }>;
+    /**
+     * Set or create child.
+     * This will just set the parent if it exists. Create it and set the parent if the group doesn’t exist.
+     */
     setOrCreateChild: (query: {
         id: string;
     } & {
@@ -54,6 +61,9 @@ export declare class Groups extends Resource<{
     }, payload: GroupRepresentation) => Promise<{
         id: string;
     }>;
+    /**
+     * Members
+     */
     listMembers: (payload?: ({
         id: string;
         first?: number | undefined;
@@ -61,6 +71,10 @@ export declare class Groups extends Resource<{
     } & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<UserRepresentation[]>;
+    /**
+     * Role mappings
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_role_mapper_resource
+     */
     listRoleMappings: (payload?: ({
         id: string;
     } & {
@@ -93,6 +107,10 @@ export declare class Groups extends Resource<{
     } & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
+    /**
+     * Client role mappings
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_client_role_mappings_resource
+     */
     listClientRoleMappings: (payload?: ({
         id: string;
         clientUniqueId: string;
@@ -125,6 +143,9 @@ export declare class Groups extends Resource<{
     } & {
         realm?: string | undefined;
     }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
+    /**
+     * Authorization permissions
+     */
     updatePermission: (query: {
         id: string;
     } & {

package/lib/resources/groups.js

@@ -1,121 +1,142 @@
-import Resource from './resource.js';
+import Resource from "./resource.js";
 export class Groups extends Resource {
+    find = this.makeRequest({
+        method: "GET",
+    });
+    create = this.makeRequest({
+        method: "POST",
+        returnResourceIdInLocationHeader: { field: "id" },
+    });
+    /**
+     * Single user
+     */
+    findOne = this.makeRequest({
+        method: "GET",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+        catchNotFound: true,
+    });
+    update = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    del = this.makeRequest({
+        method: "DELETE",
+        path: "/{id}",
+        urlParamKeys: ["id"],
+    });
+    count = this.makeRequest({
+        method: "GET",
+        path: "/count",
+    });
+    /**
+     * Set or create child.
+     * This will just set the parent if it exists. Create it and set the parent if the group doesn’t exist.
+     */
+    setOrCreateChild = this.makeUpdateRequest({
+        method: "POST",
+        path: "/{id}/children",
+        urlParamKeys: ["id"],
+        returnResourceIdInLocationHeader: { field: "id" },
+    });
+    /**
+     * Members
+     */
+    listMembers = this.makeRequest({
+        method: "GET",
+        path: "/{id}/members",
+        urlParamKeys: ["id"],
+        catchNotFound: true,
+    });
+    /**
+     * Role mappings
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_role_mapper_resource
+     */
+    listRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings",
+        urlParamKeys: ["id"],
+    });
+    addRealmRoleMappings = this.makeRequest({
+        method: "POST",
+        path: "/{id}/role-mappings/realm",
+        urlParamKeys: ["id"],
+        payloadKey: "roles",
+    });
+    listRealmRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings/realm",
+        urlParamKeys: ["id"],
+    });
+    delRealmRoleMappings = this.makeRequest({
+        method: "DELETE",
+        path: "/{id}/role-mappings/realm",
+        urlParamKeys: ["id"],
+        payloadKey: "roles",
+    });
+    listAvailableRealmRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings/realm/available",
+        urlParamKeys: ["id"],
+    });
+    // Get effective realm-level role mappings This will recurse all composite roles to get the result.
+    listCompositeRealmRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings/realm/composite",
+        urlParamKeys: ["id"],
+    });
+    /**
+     * Client role mappings
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_client_role_mappings_resource
+     */
+    listClientRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings/clients/{clientUniqueId}",
+        urlParamKeys: ["id", "clientUniqueId"],
+    });
+    addClientRoleMappings = this.makeRequest({
+        method: "POST",
+        path: "/{id}/role-mappings/clients/{clientUniqueId}",
+        urlParamKeys: ["id", "clientUniqueId"],
+        payloadKey: "roles",
+    });
+    delClientRoleMappings = this.makeRequest({
+        method: "DELETE",
+        path: "/{id}/role-mappings/clients/{clientUniqueId}",
+        urlParamKeys: ["id", "clientUniqueId"],
+        payloadKey: "roles",
+    });
+    listAvailableClientRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings/clients/{clientUniqueId}/available",
+        urlParamKeys: ["id", "clientUniqueId"],
+    });
+    listCompositeClientRoleMappings = this.makeRequest({
+        method: "GET",
+        path: "/{id}/role-mappings/clients/{clientUniqueId}/composite",
+        urlParamKeys: ["id", "clientUniqueId"],
+    });
+    /**
+     * Authorization permissions
+     */
+    updatePermission = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/{id}/management/permissions",
+        urlParamKeys: ["id"],
+    });
+    listPermissions = this.makeRequest({
+        method: "GET",
+        path: "/{id}/management/permissions",
+        urlParamKeys: ["id"],
+    });
     constructor(client) {
         super(client, {
-            path: '/admin/realms/{realm}/groups',
+            path: "/admin/realms/{realm}/groups",
             getUrlParams: () => ({
                 realm: client.realmName,
             }),
             getBaseUrl: () => client.baseUrl,
         });
-        this.find = this.makeRequest({
-            method: 'GET',
-        });
-        this.create = this.makeRequest({
-            method: 'POST',
-            returnResourceIdInLocationHeader: { field: 'id' },
-        });
-        this.findOne = this.makeRequest({
-            method: 'GET',
-            path: '/{id}',
-            urlParamKeys: ['id'],
-            catchNotFound: true,
-        });
-        this.update = this.makeUpdateRequest({
-            method: 'PUT',
-            path: '/{id}',
-            urlParamKeys: ['id'],
-        });
-        this.del = this.makeRequest({
-            method: 'DELETE',
-            path: '/{id}',
-            urlParamKeys: ['id'],
-        });
-        this.count = this.makeRequest({
-            method: 'GET',
-            path: '/count',
-        });
-        this.setOrCreateChild = this.makeUpdateRequest({
-            method: 'POST',
-            path: '/{id}/children',
-            urlParamKeys: ['id'],
-            returnResourceIdInLocationHeader: { field: 'id' },
-        });
-        this.listMembers = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/members',
-            urlParamKeys: ['id'],
-            catchNotFound: true,
-        });
-        this.listRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings',
-            urlParamKeys: ['id'],
-        });
-        this.addRealmRoleMappings = this.makeRequest({
-            method: 'POST',
-            path: '/{id}/role-mappings/realm',
-            urlParamKeys: ['id'],
-            payloadKey: 'roles',
-        });
-        this.listRealmRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings/realm',
-            urlParamKeys: ['id'],
-        });
-        this.delRealmRoleMappings = this.makeRequest({
-            method: 'DELETE',
-            path: '/{id}/role-mappings/realm',
-            urlParamKeys: ['id'],
-            payloadKey: 'roles',
-        });
-        this.listAvailableRealmRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings/realm/available',
-            urlParamKeys: ['id'],
-        });
-        this.listCompositeRealmRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings/realm/composite',
-            urlParamKeys: ['id'],
-        });
-        this.listClientRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings/clients/{clientUniqueId}',
-            urlParamKeys: ['id', 'clientUniqueId'],
-        });
-        this.addClientRoleMappings = this.makeRequest({
-            method: 'POST',
-            path: '/{id}/role-mappings/clients/{clientUniqueId}',
-            urlParamKeys: ['id', 'clientUniqueId'],
-            payloadKey: 'roles',
-        });
-        this.delClientRoleMappings = this.makeRequest({
-            method: 'DELETE',
-            path: '/{id}/role-mappings/clients/{clientUniqueId}',
-            urlParamKeys: ['id', 'clientUniqueId'],
-            payloadKey: 'roles',
-        });
-        this.listAvailableClientRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings/clients/{clientUniqueId}/available',
-            urlParamKeys: ['id', 'clientUniqueId'],
-        });
-        this.listCompositeClientRoleMappings = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/role-mappings/clients/{clientUniqueId}/composite',
-            urlParamKeys: ['id', 'clientUniqueId'],
-        });
-        this.updatePermission = this.makeUpdateRequest({
-            method: 'PUT',
-            path: '/{id}/management/permissions',
-            urlParamKeys: ['id'],
-        });
-        this.listPermissions = this.makeRequest({
-            method: 'GET',
-            path: '/{id}/management/permissions',
-            urlParamKeys: ['id'],
-        });
     }
 }
-//# sourceMappingURL=groups.js.map

package/lib/resources/identityProviders.d.ts

@@ -1,12 +1,16 @@
-import type { KeycloakAdminClient } from '../client.js';
-import type IdentityProviderMapperRepresentation from '../defs/identityProviderMapperRepresentation.js';
-import type { IdentityProviderMapperTypeRepresentation } from '../defs/identityProviderMapperTypeRepresentation.js';
-import type IdentityProviderRepresentation from '../defs/identityProviderRepresentation.js';
-import type { ManagementPermissionReference } from '../defs/managementPermissionReference.js';
-import Resource from './resource.js';
+import type { KeycloakAdminClient } from "../client.js";
+import type IdentityProviderMapperRepresentation from "../defs/identityProviderMapperRepresentation.js";
+import type { IdentityProviderMapperTypeRepresentation } from "../defs/identityProviderMapperTypeRepresentation.js";
+import type IdentityProviderRepresentation from "../defs/identityProviderRepresentation.js";
+import type { ManagementPermissionReference } from "../defs/managementPermissionReference.js";
+import Resource from "./resource.js";
 export declare class IdentityProviders extends Resource<{
     realm?: string;
 }> {
+    /**
+     * Identity provider
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_identity_providers_resource
+     */
     find: (payload?: {
         realm?: string | undefined;
     } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;

package/lib/resources/identityProviders.js

@@ -1,90 +1,93 @@
-import Resource from './resource.js';
+import Resource from "./resource.js";
 export class IdentityProviders extends Resource {
+    /**
+     * Identity provider
+     * https://www.keycloak.org/docs-api/11.0/rest-api/#_identity_providers_resource
+     */
+    find = this.makeRequest({
+        method: "GET",
+        path: "/instances",
+    });
+    create = this.makeRequest({
+        method: "POST",
+        path: "/instances",
+        returnResourceIdInLocationHeader: { field: "id" },
+    });
+    findOne = this.makeRequest({
+        method: "GET",
+        path: "/instances/{alias}",
+        urlParamKeys: ["alias"],
+        catchNotFound: true,
+    });
+    update = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/instances/{alias}",
+        urlParamKeys: ["alias"],
+    });
+    del = this.makeRequest({
+        method: "DELETE",
+        path: "/instances/{alias}",
+        urlParamKeys: ["alias"],
+    });
+    findFactory = this.makeRequest({
+        method: "GET",
+        path: "/providers/{providerId}",
+        urlParamKeys: ["providerId"],
+    });
+    findMappers = this.makeRequest({
+        method: "GET",
+        path: "/instances/{alias}/mappers",
+        urlParamKeys: ["alias"],
+    });
+    findOneMapper = this.makeRequest({
+        method: "GET",
+        path: "/instances/{alias}/mappers/{id}",
+        urlParamKeys: ["alias", "id"],
+        catchNotFound: true,
+    });
+    createMapper = this.makeRequest({
+        method: "POST",
+        path: "/instances/{alias}/mappers",
+        urlParamKeys: ["alias"],
+        payloadKey: "identityProviderMapper",
+        returnResourceIdInLocationHeader: { field: "id" },
+    });
+    updateMapper = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/instances/{alias}/mappers/{id}",
+        urlParamKeys: ["alias", "id"],
+    });
+    delMapper = this.makeRequest({
+        method: "DELETE",
+        path: "/instances/{alias}/mappers/{id}",
+        urlParamKeys: ["alias", "id"],
+    });
+    findMapperTypes = this.makeRequest({
+        method: "GET",
+        path: "/instances/{alias}/mapper-types",
+        urlParamKeys: ["alias"],
+    });
+    importFromUrl = this.makeRequest({
+        method: "POST",
+        path: "/import-config",
+    });
+    updatePermission = this.makeUpdateRequest({
+        method: "PUT",
+        path: "/instances/{alias}/management/permissions",
+        urlParamKeys: ["alias"],
+    });
+    listPermissions = this.makeRequest({
+        method: "GET",
+        path: "/instances/{alias}/management/permissions",
+        urlParamKeys: ["alias"],
+    });
     constructor(client) {
         super(client, {
-            path: '/admin/realms/{realm}/identity-provider',
+            path: "/admin/realms/{realm}/identity-provider",
             getUrlParams: () => ({
                 realm: client.realmName,
             }),
             getBaseUrl: () => client.baseUrl,
         });
-        this.find = this.makeRequest({
-            method: 'GET',
-            path: '/instances',
-        });
-        this.create = this.makeRequest({
-            method: 'POST',
-            path: '/instances',
-            returnResourceIdInLocationHeader: { field: 'id' },
-        });
-        this.findOne = this.makeRequest({
-            method: 'GET',
-            path: '/instances/{alias}',
-            urlParamKeys: ['alias'],
-            catchNotFound: true,
-        });
-        this.update = this.makeUpdateRequest({
-            method: 'PUT',
-            path: '/instances/{alias}',
-            urlParamKeys: ['alias'],
-        });
-        this.del = this.makeRequest({
-            method: 'DELETE',
-            path: '/instances/{alias}',
-            urlParamKeys: ['alias'],
-        });
-        this.findFactory = this.makeRequest({
-            method: 'GET',
-            path: '/providers/{providerId}',
-            urlParamKeys: ['providerId'],
-        });
-        this.findMappers = this.makeRequest({
-            method: 'GET',
-            path: '/instances/{alias}/mappers',
-            urlParamKeys: ['alias'],
-        });
-        this.findOneMapper = this.makeRequest({
-            method: 'GET',
-            path: '/instances/{alias}/mappers/{id}',
-            urlParamKeys: ['alias', 'id'],
-            catchNotFound: true,
-        });
-        this.createMapper = this.makeRequest({
-            method: 'POST',
-            path: '/instances/{alias}/mappers',
-            urlParamKeys: ['alias'],
-            payloadKey: 'identityProviderMapper',
-            returnResourceIdInLocationHeader: { field: 'id' },
-        });
-        this.updateMapper = this.makeUpdateRequest({
-            method: 'PUT',
-            path: '/instances/{alias}/mappers/{id}',
-            urlParamKeys: ['alias', 'id'],
-        });
-        this.delMapper = this.makeRequest({
-            method: 'DELETE',
-            path: '/instances/{alias}/mappers/{id}',
-            urlParamKeys: ['alias', 'id'],
-        });
-        this.findMapperTypes = this.makeRequest({
-            method: 'GET',
-            path: '/instances/{alias}/mapper-types',
-            urlParamKeys: ['alias'],
-        });
-        this.importFromUrl = this.makeRequest({
-            method: 'POST',
-            path: '/import-config',
-        });
-        this.updatePermission = this.makeUpdateRequest({
-            method: 'PUT',
-            path: '/instances/{alias}/management/permissions',
-            urlParamKeys: ['alias'],
-        });
-        this.listPermissions = this.makeRequest({
-            method: 'GET',
-            path: '/instances/{alias}/management/permissions',
-            urlParamKeys: ['alias'],
-        });
     }
 }
-//# sourceMappingURL=identityProviders.js.map