@keycloak/keycloak-admin-client 23.0.7 → 24.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/client.d.ts CHANGED
@@ -43,6 +43,7 @@ export declare class KeycloakAdminClient {
43
43
  cache: Cache;
44
44
  baseUrl: string;
45
45
  realmName: string;
46
+ scope?: string;
46
47
  accessToken?: string;
47
48
  refreshToken?: string;
48
49
  constructor(connectionConfig?: ConnectionConfig);
package/lib/client.js CHANGED
@@ -35,6 +35,7 @@ export class KeycloakAdminClient {
35
35
  // Members
36
36
  baseUrl;
37
37
  realmName;
38
+ scope;
38
39
  accessToken;
39
40
  refreshToken;
40
41
  #requestOptions;
@@ -66,6 +67,7 @@ export class KeycloakAdminClient {
66
67
  const { accessToken, refreshToken } = await getToken({
67
68
  baseUrl: this.baseUrl,
68
69
  realmName: this.realmName,
70
+ scope: this.scope,
69
71
  credentials,
70
72
  requestOptions: this.#requestOptions,
71
73
  });
@@ -12,4 +12,5 @@ export interface AuthenticationProviderRepresentation {
12
12
  id?: string;
13
13
  displayName?: string;
14
14
  description?: string;
15
+ supportsSecret?: boolean;
15
16
  }
@@ -1,6 +1,5 @@
1
1
  export default interface EffectiveMessageBundleRepresentation {
2
- theme?: string;
3
- themeType?: string;
4
- locale?: string;
5
- source?: boolean;
2
+ key: string;
3
+ value: string;
4
+ source: "THEME" | "REALM";
6
5
  }
@@ -69,6 +69,7 @@ export default interface RealmRepresentation {
69
69
  loginWithEmailAllowed?: boolean;
70
70
  maxDeltaTimeSeconds?: number;
71
71
  maxFailureWaitSeconds?: number;
72
+ maxTemporaryLockouts?: number;
72
73
  minimumQuickLoginWaitSeconds?: number;
73
74
  notBefore?: number;
74
75
  oauth2DeviceCodeLifespan?: number;
@@ -1,6 +1,7 @@
1
- export default interface UserProfileConfig {
1
+ export interface UserProfileConfig {
2
2
  attributes?: UserProfileAttribute[];
3
3
  groups?: UserProfileGroup[];
4
+ unmanagedAttributePolicy?: UnmanagedAttributePolicy;
4
5
  }
5
6
  export interface UserProfileAttribute {
6
7
  name?: string;
@@ -13,6 +14,7 @@ export interface UserProfileAttribute {
13
14
  selector?: UserProfileAttributeSelector;
14
15
  displayName?: string;
15
16
  group?: string;
17
+ multivalued?: boolean;
16
18
  }
17
19
  export interface UserProfileAttributeRequired {
18
20
  roles?: string[];
@@ -39,6 +41,7 @@ export interface UserProfileAttributeMetadata {
39
41
  group?: string;
40
42
  annotations?: Record<string, unknown>;
41
43
  validators?: Record<string, Record<string, unknown>>;
44
+ multivalued?: boolean;
42
45
  }
43
46
  export interface UserProfileAttributeGroupMetadata {
44
47
  name?: string;
@@ -50,3 +53,9 @@ export interface UserProfileMetadata {
50
53
  attributes?: UserProfileAttributeMetadata[];
51
54
  groups?: UserProfileAttributeGroupMetadata[];
52
55
  }
56
+ export declare enum UnmanagedAttributePolicy {
57
+ Disabled = "DISABLED",
58
+ Enabled = "ENABLED",
59
+ AdminView = "ADMIN_VIEW",
60
+ AdminEdit = "ADMIN_EDIT"
61
+ }
@@ -1 +1,7 @@
1
- export {};
1
+ export var UnmanagedAttributePolicy;
2
+ (function (UnmanagedAttributePolicy) {
3
+ UnmanagedAttributePolicy["Disabled"] = "DISABLED";
4
+ UnmanagedAttributePolicy["Enabled"] = "ENABLED";
5
+ UnmanagedAttributePolicy["AdminView"] = "ADMIN_VIEW";
6
+ UnmanagedAttributePolicy["AdminEdit"] = "ADMIN_EDIT";
7
+ })(UnmanagedAttributePolicy || (UnmanagedAttributePolicy = {}));
@@ -1,10 +1,11 @@
1
- import { isUndefined, last, omit, pick } from "lodash-es";
2
1
  import urlJoin from "url-join";
3
2
  import { parseTemplate } from "url-template";
4
3
  import { fetchWithError, NetworkError, parseResponse, } from "../utils/fetchWithError.js";
5
4
  import { stringifyQueryParams } from "../utils/stringifyQueryParams.js";
6
5
  // constants
7
6
  const SLASH = "/";
7
+ const pick = (value, keys) => Object.fromEntries(Object.entries(value).filter(([key]) => keys.includes(key)));
8
+ const omit = (value, keys) => Object.fromEntries(Object.entries(value).filter(([key]) => !keys.includes(key)));
8
9
  export class Agent {
9
10
  #client;
10
11
  #basePath;
@@ -20,7 +21,9 @@ export class Agent {
20
21
  return async (payload = {}, options) => {
21
22
  const baseParams = this.#getBaseParams?.() ?? {};
22
23
  // Filter query parameters by queryParamKeys
23
- const queryParams = queryParamKeys.length > 0 ? pick(payload, queryParamKeys) : undefined;
24
+ const queryParams = queryParamKeys.length > 0
25
+ ? pick(payload, queryParamKeys)
26
+ : undefined;
24
27
  // Add filtered payload parameters to base parameters
25
28
  const allUrlParamKeys = [...Object.keys(baseParams), ...urlParamKeys];
26
29
  const urlParams = { ...baseParams, ...pick(payload, allUrlParamKeys) };
@@ -132,7 +135,7 @@ export class Agent {
132
135
  if (typeof locationHeader !== "string") {
133
136
  throw new Error(`location header is not found in request: ${res.url}`);
134
137
  }
135
- const resourceId = last(locationHeader.split(SLASH));
138
+ const resourceId = locationHeader.split(SLASH).pop();
136
139
  if (!resourceId) {
137
140
  // throw an error to let users know the response is not expected
138
141
  throw new Error(`resourceId is not found in Location header from request: ${res.url}`);
@@ -161,8 +164,7 @@ export class Agent {
161
164
  return;
162
165
  }
163
166
  Object.keys(keyMapping).some((key) => {
164
- if (isUndefined(payload[key])) {
165
- // Skip if undefined
167
+ if (typeof payload[key] === "undefined") {
166
168
  return false;
167
169
  }
168
170
  const newKey = keyMapping[key];
@@ -7,87 +7,151 @@ import type AuthenticatorConfigRepresentation from "../defs/authenticatorConfigR
7
7
  import type { AuthenticationProviderRepresentation } from "../defs/authenticatorConfigRepresentation.js";
8
8
  import type AuthenticatorConfigInfoRepresentation from "../defs/authenticatorConfigInfoRepresentation.js";
9
9
  import type RequiredActionProviderSimpleRepresentation from "../defs/requiredActionProviderSimpleRepresentation.js";
10
- export declare class AuthenticationManagement extends Resource {
10
+ export declare class AuthenticationManagement extends Resource<{
11
+ realm?: string;
12
+ }> {
11
13
  /**
12
14
  * Authentication Management
13
15
  * https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_authentication_management_resource
14
16
  */
15
- registerRequiredAction: (payload?: Record<string, any> | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
16
- getRequiredActions: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderRepresentation[]>;
17
- getRequiredActionForAlias: (payload?: {
17
+ registerRequiredAction: (payload?: (Record<string, any> & {
18
+ realm?: string | undefined;
19
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
20
+ getRequiredActions: (payload?: (void & {
21
+ realm?: string | undefined;
22
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderRepresentation[]>;
23
+ getRequiredActionForAlias: (payload?: ({
18
24
  alias: string;
19
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
20
- getClientAuthenticatorProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
21
- getAuthenticatorProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
22
- getFormActionProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
25
+ } & {
26
+ realm?: string | undefined;
27
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
28
+ getClientAuthenticatorProviders: (payload?: (void & {
29
+ realm?: string | undefined;
30
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
31
+ getAuthenticatorProviders: (payload?: (void & {
32
+ realm?: string | undefined;
33
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
34
+ getFormActionProviders: (payload?: (void & {
35
+ realm?: string | undefined;
36
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
23
37
  updateRequiredAction: (query: {
24
38
  alias: string;
39
+ } & {
40
+ realm?: string | undefined;
25
41
  }, payload: RequiredActionProviderRepresentation) => Promise<void>;
26
- deleteRequiredAction: (payload?: {
42
+ deleteRequiredAction: (payload?: ({
27
43
  alias: string;
28
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
29
- lowerRequiredActionPriority: (payload?: {
44
+ } & {
45
+ realm?: string | undefined;
46
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
47
+ lowerRequiredActionPriority: (payload?: ({
30
48
  alias: string;
31
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
32
- raiseRequiredActionPriority: (payload?: {
49
+ } & {
50
+ realm?: string | undefined;
51
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
52
+ raiseRequiredActionPriority: (payload?: ({
33
53
  alias: string;
34
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
35
- getUnregisteredRequiredActions: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderSimpleRepresentation[]>;
36
- getFlows: (payload?: {} | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation[]>;
37
- getFlow: (payload?: {
54
+ } & {
55
+ realm?: string | undefined;
56
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
57
+ getUnregisteredRequiredActions: (payload?: (void & {
58
+ realm?: string | undefined;
59
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<RequiredActionProviderSimpleRepresentation[]>;
60
+ getFlows: (payload?: {
61
+ realm?: string | undefined;
62
+ } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation[]>;
63
+ getFlow: (payload?: ({
38
64
  flowId: string;
39
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
40
- getFormProviders: (payload?: (void & {}) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
41
- createFlow: (payload?: AuthenticationFlowRepresentation | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
42
- copyFlow: (payload?: {
65
+ } & {
66
+ realm?: string | undefined;
67
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
68
+ getFormProviders: (payload?: (void & {
69
+ realm?: string | undefined;
70
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationProviderRepresentation[]>;
71
+ createFlow: (payload?: (AuthenticationFlowRepresentation & {
72
+ realm?: string | undefined;
73
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
74
+ copyFlow: (payload?: ({
43
75
  flow: string;
44
76
  newName: string;
45
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
46
- deleteFlow: (payload?: {
77
+ } & {
78
+ realm?: string | undefined;
79
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
80
+ deleteFlow: (payload?: ({
47
81
  flowId: string;
48
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
82
+ } & {
83
+ realm?: string | undefined;
84
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
49
85
  updateFlow: (query: {
50
86
  flowId: string;
87
+ } & {
88
+ realm?: string | undefined;
51
89
  }, payload: AuthenticationFlowRepresentation) => Promise<any>;
52
- getExecutions: (payload?: {
90
+ getExecutions: (payload?: ({
53
91
  flow: string;
54
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation[]>;
92
+ } & {
93
+ realm?: string | undefined;
94
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation[]>;
55
95
  addExecution: (query: {
56
96
  flow: string;
97
+ } & {
98
+ realm?: string | undefined;
57
99
  }, payload: AuthenticationExecutionInfoRepresentation) => Promise<any>;
58
- addExecutionToFlow: (payload?: {
100
+ addExecutionToFlow: (payload?: ({
59
101
  flow: string;
60
102
  provider: string;
61
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation>;
62
- addFlowToFlow: (payload?: {
103
+ } & {
104
+ realm?: string | undefined;
105
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationExecutionInfoRepresentation>;
106
+ addFlowToFlow: (payload?: ({
63
107
  flow: string;
64
108
  alias: string;
65
109
  type: string;
66
110
  provider: string;
67
111
  description: string;
68
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
112
+ } & {
113
+ realm?: string | undefined;
114
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticationFlowRepresentation>;
69
115
  updateExecution: (query: {
70
116
  flow: string;
117
+ } & {
118
+ realm?: string | undefined;
71
119
  }, payload: AuthenticationExecutionInfoRepresentation) => Promise<any>;
72
- delExecution: (payload?: {
120
+ delExecution: (payload?: ({
73
121
  id: string;
74
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
75
- lowerPriorityExecution: (payload?: {
122
+ } & {
123
+ realm?: string | undefined;
124
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
125
+ lowerPriorityExecution: (payload?: ({
76
126
  id: string;
77
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
78
- raisePriorityExecution: (payload?: {
127
+ } & {
128
+ realm?: string | undefined;
129
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
130
+ raisePriorityExecution: (payload?: ({
79
131
  id: string;
80
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
81
- getConfigDescription: (payload?: {
132
+ } & {
133
+ realm?: string | undefined;
134
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
135
+ getConfigDescription: (payload?: ({
82
136
  providerId: string;
83
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigInfoRepresentation>;
84
- createConfig: (payload?: AuthenticatorConfigRepresentation | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
85
- updateConfig: (payload?: AuthenticatorConfigRepresentation | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
86
- getConfig: (payload?: {
137
+ } & {
138
+ realm?: string | undefined;
139
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigInfoRepresentation>;
140
+ createConfig: (payload?: (AuthenticatorConfigRepresentation & {
141
+ realm?: string | undefined;
142
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
143
+ updateConfig: (payload?: (AuthenticatorConfigRepresentation & {
144
+ realm?: string | undefined;
145
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
146
+ getConfig: (payload?: ({
87
147
  id: string;
88
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
89
- delConfig: (payload?: {
148
+ } & {
149
+ realm?: string | undefined;
150
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<AuthenticatorConfigRepresentation>;
151
+ delConfig: (payload?: ({
90
152
  id: string;
91
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
153
+ } & {
154
+ realm?: string | undefined;
155
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<any>;
92
156
  constructor(client: KeycloakAdminClient);
93
157
  }
@@ -7,6 +7,7 @@ import type { RoleMappingPayload } from "../defs/roleRepresentation.js";
7
7
  import type UserRepresentation from "../defs/userRepresentation.js";
8
8
  import Resource from "./resource.js";
9
9
  interface Query {
10
+ q?: string;
10
11
  search?: string;
11
12
  exact?: boolean;
12
13
  }
@@ -2,7 +2,14 @@ import Resource from "./resource.js";
2
2
  export class Groups extends Resource {
3
3
  find = this.makeRequest({
4
4
  method: "GET",
5
- queryParamKeys: ["search", "exact", "briefRepresentation", "first", "max"],
5
+ queryParamKeys: [
6
+ "search",
7
+ "q",
8
+ "exact",
9
+ "briefRepresentation",
10
+ "first",
11
+ "max",
12
+ ],
6
13
  });
7
14
  create = this.makeRequest({
8
15
  method: "POST",
@@ -4,6 +4,13 @@ import type { IdentityProviderMapperTypeRepresentation } from "../defs/identityP
4
4
  import type IdentityProviderRepresentation from "../defs/identityProviderRepresentation.js";
5
5
  import type { ManagementPermissionReference } from "../defs/managementPermissionReference.js";
6
6
  import Resource from "./resource.js";
7
+ export interface PaginatedQuery {
8
+ first?: number;
9
+ max?: number;
10
+ }
11
+ export interface IdentityProvidersQuery extends PaginatedQuery {
12
+ search?: string;
13
+ }
7
14
  export declare class IdentityProviders extends Resource<{
8
15
  realm?: string;
9
16
  }> {
@@ -11,9 +18,9 @@ export declare class IdentityProviders extends Resource<{
11
18
  * Identity provider
12
19
  * https://www.keycloak.org/docs-api/11.0/rest-api/#_identity_providers_resource
13
20
  */
14
- find: (payload?: {
21
+ find: (payload?: (IdentityProvidersQuery & {
15
22
  realm?: string | undefined;
16
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;
23
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<IdentityProviderRepresentation[]>;
17
24
  create: (payload?: (IdentityProviderRepresentation & {
18
25
  realm?: string | undefined;
19
26
  }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<{
@@ -91,5 +98,10 @@ export declare class IdentityProviders extends Resource<{
91
98
  } & {
92
99
  realm?: string | undefined;
93
100
  }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ManagementPermissionReference>;
101
+ reloadKeys: (payload?: ({
102
+ alias: string;
103
+ } & {
104
+ realm?: string | undefined;
105
+ }) | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<boolean>;
94
106
  constructor(client: KeycloakAdminClient);
95
107
  }
@@ -81,6 +81,11 @@ export class IdentityProviders extends Resource {
81
81
  path: "/instances/{alias}/management/permissions",
82
82
  urlParamKeys: ["alias"],
83
83
  });
84
+ reloadKeys = this.makeRequest({
85
+ method: "GET",
86
+ path: "/instances/{alias}/reload-keys",
87
+ urlParamKeys: ["alias"],
88
+ });
84
89
  constructor(client) {
85
90
  super(client, {
86
91
  path: "/admin/realms/{realm}/identity-provider",
@@ -2,14 +2,15 @@ import Resource from "./resource.js";
2
2
  import type { ServerInfoRepresentation } from "../defs/serverInfoRepesentation.js";
3
3
  import type KeycloakAdminClient from "../index.js";
4
4
  import type EffectiveMessageBundleRepresentation from "../defs/effectiveMessageBundleRepresentation.js";
5
+ export interface MessageBundleQuery {
6
+ realm: string;
7
+ theme?: string;
8
+ themeType?: string;
9
+ locale?: string;
10
+ source?: boolean;
11
+ }
5
12
  export declare class ServerInfo extends Resource {
6
13
  constructor(client: KeycloakAdminClient);
7
14
  find: (payload?: {} | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<ServerInfoRepresentation>;
8
- findEffectiveMessageBundles: (payload?: {
9
- realm: string;
10
- theme?: string | undefined;
11
- themeType?: string | undefined;
12
- locale?: string | undefined;
13
- source?: boolean | undefined;
14
- } | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<EffectiveMessageBundleRepresentation[]>;
15
+ findEffectiveMessageBundles: (payload?: MessageBundleQuery | undefined, options?: Pick<import("./agent.js").RequestArgs, "catchNotFound"> | undefined) => Promise<EffectiveMessageBundleRepresentation[]>;
15
16
  }
@@ -6,8 +6,7 @@ import type MappingsRepresentation from "../defs/mappingsRepresentation.js";
6
6
  import type RoleRepresentation from "../defs/roleRepresentation.js";
7
7
  import type { RoleMappingPayload } from "../defs/roleRepresentation.js";
8
8
  import type UserConsentRepresentation from "../defs/userConsentRepresentation.js";
9
- import type UserProfileConfig from "../defs/userProfileMetadata.js";
10
- import type { UserProfileMetadata } from "../defs/userProfileMetadata.js";
9
+ import type { UserProfileConfig, UserProfileMetadata } from "../defs/userProfileMetadata.js";
11
10
  import type UserRepresentation from "../defs/userRepresentation.js";
12
11
  import type UserSessionRepresentation from "../defs/userSessionRepresentation.js";
13
12
  import Resource from "./resource.js";
@@ -13,6 +13,7 @@ export interface Credentials {
13
13
  export interface Settings {
14
14
  realmName?: string;
15
15
  baseUrl?: string;
16
+ scope?: string;
16
17
  credentials: Credentials;
17
18
  requestOptions?: RequestInit;
18
19
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@keycloak/keycloak-admin-client",
3
- "version": "23.0.7",
3
+ "version": "24.0.0",
4
4
  "description": "A client to interact with Keycloak's Administration API",
5
5
  "type": "module",
6
6
  "main": "lib/index.js",
@@ -32,19 +32,19 @@
32
32
  },
33
33
  "dependencies": {
34
34
  "camelize-ts": "^3.0.0",
35
- "lodash-es": "^4.17.21",
36
35
  "url-join": "^5.0.0",
37
- "url-template": "^3.1.0"
36
+ "url-template": "^3.1.1"
38
37
  },
39
38
  "devDependencies": {
40
- "@faker-js/faker": "^8.3.1",
41
- "@types/chai": "^4.3.11",
39
+ "@faker-js/faker": "^8.4.1",
40
+ "@types/chai": "^4.3.12",
42
41
  "@types/lodash-es": "^4.17.12",
43
42
  "@types/mocha": "^10.0.6",
44
- "@types/node": "^20.9.4",
45
- "chai": "^4.3.10",
46
- "mocha": "^10.2.0",
47
- "ts-node": "^10.9.1"
43
+ "@types/node": "^20.11.24",
44
+ "chai": "^5.1.0",
45
+ "lodash-es": "^4.17.21",
46
+ "mocha": "^10.3.0",
47
+ "ts-node": "^10.9.2"
48
48
  },
49
49
  "author": {
50
50
  "name": "Red Hat, Inc.",