@keycloak/keycloak-admin-client 17.0.0-dev.21 → 17.0.0-dev.25

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.
Files changed (30) hide show
  1. package/lib/client.d.ts +4 -0
  2. package/lib/client.js +4 -0
  3. package/lib/client.js.map +1 -1
  4. package/lib/defs/policyRepresentation.d.ts +4 -0
  5. package/lib/defs/policyRepresentation.js +6 -1
  6. package/lib/defs/policyRepresentation.js.map +1 -1
  7. package/lib/defs/policyResultRepresentation.d.ts +7 -0
  8. package/lib/defs/policyResultRepresentation.js +3 -0
  9. package/lib/defs/policyResultRepresentation.js.map +1 -0
  10. package/lib/resources/agent.d.ts +1 -1
  11. package/lib/resources/agent.js +4 -14
  12. package/lib/resources/agent.js.map +1 -1
  13. package/lib/resources/attackDetection.d.ts +3 -3
  14. package/lib/resources/authenticationManagement.d.ts +27 -27
  15. package/lib/resources/cache.d.ts +1 -1
  16. package/lib/resources/clientPolicies.d.ts +4 -4
  17. package/lib/resources/clientScopes.d.ts +21 -21
  18. package/lib/resources/clients.d.ts +68 -68
  19. package/lib/resources/components.d.ts +5 -5
  20. package/lib/resources/groups.d.ts +18 -18
  21. package/lib/resources/identityProviders.d.ts +11 -11
  22. package/lib/resources/realms.d.ts +26 -26
  23. package/lib/resources/resource.d.ts +1 -1
  24. package/lib/resources/roles.d.ts +10 -10
  25. package/lib/resources/serverInfo.d.ts +1 -1
  26. package/lib/resources/sessions.d.ts +1 -1
  27. package/lib/resources/userStorageProvider.d.ts +5 -5
  28. package/lib/resources/users.d.ts +38 -38
  29. package/lib/resources/whoAmI.d.ts +1 -1
  30. package/package.json +1 -1
package/lib/resources/users.d.ts CHANGED
@@ -26,17 +26,17 @@ export declare class Users extends Resource<{
26
26
  }> {
27
27
  find: (payload?: (UserQuery & {
28
28
  realm?: string | undefined;
29
- }) | undefined) => Promise<UserRepresentation[]>;
29
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserRepresentation[]>;
30
30
  create: (payload?: (UserRepresentation & {
31
31
  realm?: string | undefined;
32
- }) | undefined) => Promise<{
32
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
33
33
  id: string;
34
34
  }>;
35
35
  findOne: (payload?: ({
36
36
  id: string;
37
37
  } & {
38
38
  realm?: string | undefined;
39
- }) | undefined) => Promise<UserRepresentation | undefined>;
39
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserRepresentation | undefined>;
40
40
  update: (query: {
41
41
  id: string;
42
42
  } & {
@@ -46,80 +46,80 @@ export declare class Users extends Resource<{
46
46
  id: string;
47
47
  } & {
48
48
  realm?: string | undefined;
49
- }) | undefined) => Promise<void>;
49
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
50
50
  count: (payload?: (UserQuery & {
51
51
  realm?: string | undefined;
52
- }) | undefined) => Promise<number>;
52
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<number>;
53
53
  getProfile: (payload?: {
54
54
  realm?: string | undefined;
55
- } | undefined) => Promise<UserProfileConfig>;
55
+ } | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserProfileConfig>;
56
56
  updateProfile: (payload?: (UserProfileConfig & {
57
57
  realm?: string | undefined;
58
- }) | undefined) => Promise<UserProfileConfig>;
58
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserProfileConfig>;
59
59
  listRoleMappings: (payload?: ({
60
60
  id: string;
61
61
  } & {
62
62
  realm?: string | undefined;
63
- }) | undefined) => Promise<MappingsRepresentation>;
63
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<MappingsRepresentation>;
64
64
  addRealmRoleMappings: (payload?: ({
65
65
  id: string;
66
66
  roles: RoleMappingPayload[];
67
67
  } & {
68
68
  realm?: string | undefined;
69
- }) | undefined) => Promise<void>;
69
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
70
70
  listRealmRoleMappings: (payload?: ({
71
71
  id: string;
72
72
  } & {
73
73
  realm?: string | undefined;
74
- }) | undefined) => Promise<RoleRepresentation[]>;
74
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
75
75
  delRealmRoleMappings: (payload?: ({
76
76
  id: string;
77
77
  roles: RoleMappingPayload[];
78
78
  } & {
79
79
  realm?: string | undefined;
80
- }) | undefined) => Promise<void>;
80
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
81
81
  listAvailableRealmRoleMappings: (payload?: ({
82
82
  id: string;
83
83
  } & {
84
84
  realm?: string | undefined;
85
- }) | undefined) => Promise<RoleRepresentation[]>;
85
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
86
86
  listCompositeRealmRoleMappings: (payload?: ({
87
87
  id: string;
88
88
  } & {
89
89
  realm?: string | undefined;
90
- }) | undefined) => Promise<RoleRepresentation[]>;
90
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
91
91
  listClientRoleMappings: (payload?: ({
92
92
  id: string;
93
93
  clientUniqueId: string;
94
94
  } & {
95
95
  realm?: string | undefined;
96
- }) | undefined) => Promise<RoleRepresentation[]>;
96
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
97
97
  addClientRoleMappings: (payload?: ({
98
98
  id: string;
99
99
  clientUniqueId: string;
100
100
  roles: RoleMappingPayload[];
101
101
  } & {
102
102
  realm?: string | undefined;
103
- }) | undefined) => Promise<void>;
103
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
104
104
  delClientRoleMappings: (payload?: ({
105
105
  id: string;
106
106
  clientUniqueId: string;
107
107
  roles: RoleMappingPayload[];
108
108
  } & {
109
109
  realm?: string | undefined;
110
- }) | undefined) => Promise<void>;
110
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
111
111
  listAvailableClientRoleMappings: (payload?: ({
112
112
  id: string;
113
113
  clientUniqueId: string;
114
114
  } & {
115
115
  realm?: string | undefined;
116
- }) | undefined) => Promise<RoleRepresentation[]>;
116
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
117
117
  listCompositeClientRoleMappings: (payload?: ({
118
118
  id: string;
119
119
  clientUniqueId: string;
120
120
  } & {
121
121
  realm?: string | undefined;
122
- }) | undefined) => Promise<RoleRepresentation[]>;
122
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<RoleRepresentation[]>;
123
123
  executeActionsEmail: (payload?: ({
124
124
  id: string;
125
125
  clientId?: string | undefined;
@@ -128,73 +128,73 @@ export declare class Users extends Resource<{
128
128
  actions?: RequiredActionAlias[] | undefined;
129
129
  } & {
130
130
  realm?: string | undefined;
131
- }) | undefined) => Promise<void>;
131
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
132
132
  listGroups: (payload?: ({
133
133
  id: string;
134
134
  briefRepresentation?: boolean | undefined;
135
135
  } & {
136
136
  realm?: string | undefined;
137
- }) | undefined) => Promise<GroupRepresentation[]>;
137
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<GroupRepresentation[]>;
138
138
  addToGroup: (payload?: ({
139
139
  id: string;
140
140
  groupId: string;
141
141
  } & {
142
142
  realm?: string | undefined;
143
- }) | undefined) => Promise<string>;
143
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<string>;
144
144
  delFromGroup: (payload?: ({
145
145
  id: string;
146
146
  groupId: string;
147
147
  } & {
148
148
  realm?: string | undefined;
149
- }) | undefined) => Promise<string>;
149
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<string>;
150
150
  countGroups: (payload?: ({
151
151
  id: string;
152
152
  search?: string | undefined;
153
153
  } & {
154
154
  realm?: string | undefined;
155
- }) | undefined) => Promise<{
155
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<{
156
156
  count: number;
157
157
  }>;
158
158
  listFederatedIdentities: (payload?: ({
159
159
  id: string;
160
160
  } & {
161
161
  realm?: string | undefined;
162
- }) | undefined) => Promise<FederatedIdentityRepresentation[]>;
162
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<FederatedIdentityRepresentation[]>;
163
163
  addToFederatedIdentity: (payload?: ({
164
164
  id: string;
165
165
  federatedIdentityId: string;
166
166
  federatedIdentity: FederatedIdentityRepresentation;
167
167
  } & {
168
168
  realm?: string | undefined;
169
- }) | undefined) => Promise<void>;
169
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
170
170
  delFromFederatedIdentity: (payload?: ({
171
171
  id: string;
172
172
  federatedIdentityId: string;
173
173
  } & {
174
174
  realm?: string | undefined;
175
- }) | undefined) => Promise<void>;
175
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
176
176
  removeTotp: (payload?: ({
177
177
  id: string;
178
178
  } & {
179
179
  realm?: string | undefined;
180
- }) | undefined) => Promise<void>;
180
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
181
181
  resetPassword: (payload?: ({
182
182
  id: string;
183
183
  credential: CredentialRepresentation;
184
184
  } & {
185
185
  realm?: string | undefined;
186
- }) | undefined) => Promise<void>;
186
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
187
187
  getCredentials: (payload?: ({
188
188
  id: string;
189
189
  } & {
190
190
  realm?: string | undefined;
191
- }) | undefined) => Promise<CredentialRepresentation[]>;
191
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<CredentialRepresentation[]>;
192
192
  deleteCredential: (payload?: ({
193
193
  id: string;
194
194
  credentialId: string;
195
195
  } & {
196
196
  realm?: string | undefined;
197
- }) | undefined) => Promise<void>;
197
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
198
198
  updateCredentialLabel: (query: {
199
199
  id: string;
200
200
  credentialId: string;
@@ -207,41 +207,41 @@ export declare class Users extends Resource<{
207
207
  newPreviousCredentialId: string;
208
208
  } & {
209
209
  realm?: string | undefined;
210
- }) | undefined) => Promise<void>;
210
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
211
211
  moveCredentialPositionUp: (payload?: ({
212
212
  id: string;
213
213
  credentialId: string;
214
214
  } & {
215
215
  realm?: string | undefined;
216
- }) | undefined) => Promise<void>;
216
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
217
217
  sendVerifyEmail: (payload?: ({
218
218
  id: string;
219
219
  clientId?: string | undefined;
220
220
  redirectUri?: string | undefined;
221
221
  } & {
222
222
  realm?: string | undefined;
223
- }) | undefined) => Promise<void>;
223
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
224
224
  listSessions: (payload?: ({
225
225
  id: string;
226
226
  } & {
227
227
  realm?: string | undefined;
228
- }) | undefined) => Promise<UserSessionRepresentation[]>;
228
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserSessionRepresentation[]>;
229
229
  listOfflineSessions: (payload?: ({
230
230
  id: string;
231
231
  clientId: string;
232
232
  } & {
233
233
  realm?: string | undefined;
234
- }) | undefined) => Promise<UserSessionRepresentation[]>;
234
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserSessionRepresentation[]>;
235
235
  logout: (payload?: ({
236
236
  id: string;
237
237
  } & {
238
238
  realm?: string | undefined;
239
- }) | undefined) => Promise<void>;
239
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
240
240
  listConsents: (payload?: ({
241
241
  id: string;
242
242
  } & {
243
243
  realm?: string | undefined;
244
- }) | undefined) => Promise<UserConsentRepresentation[]>;
244
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<UserConsentRepresentation[]>;
245
245
  impersonation: (query: {
246
246
  id: string;
247
247
  } & {
@@ -255,6 +255,6 @@ export declare class Users extends Resource<{
255
255
  clientId: string;
256
256
  } & {
257
257
  realm?: string | undefined;
258
- }) | undefined) => Promise<void>;
258
+ }) | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<void>;
259
259
  constructor(client: KeycloakAdminClient);
260
260
  }
package/lib/resources/whoAmI.d.ts CHANGED
@@ -7,5 +7,5 @@ export declare class WhoAmI extends Resource<{
7
7
  constructor(client: KeycloakAdminClient);
8
8
  find: (payload?: {
9
9
  realm?: string | undefined;
10
- } | undefined) => Promise<WhoAmIRepresentation>;
10
+ } | undefined, options?: Pick<import("./agent").RequestArgs, "catchNotFound"> | undefined) => Promise<WhoAmIRepresentation>;
11
11
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@keycloak/keycloak-admin-client",
3
- "version": "17.0.0-dev.21",
3
+ "version": "17.0.0-dev.25",
4
4
  "description": "keycloak admin client",
5
5
  "main": "lib/index.js",
6
6
  "files": [