@targetprocess/auth-client 3.2.2 → 3.2.4-ci.8

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/bin/client.d.ts CHANGED
@@ -6,143 +6,168 @@ export interface IAuthClient {
6
6
  createTenant(body: Tenant): Promise<TenantId>;
7
7
  /**
8
8
  * Update tenant
9
- * @tenantId Tenant Id
9
+ * @param tenantId Tenant Id
10
10
  * @return Updated
11
11
  */
12
12
  updateTenant(body: Tenant, tenantId: string): Promise<void>;
13
13
  /**
14
14
  * Get tenant details
15
- * @tenantId Tenant Id
15
+ * @param tenantId Tenant Id
16
16
  * @return OK
17
17
  */
18
18
  getTenant(tenantId: string): Promise<Tenant>;
19
19
  /**
20
20
  * Delete tenant
21
- * @tenantId Tenant Id
21
+ * @param tenantId Tenant Id
22
22
  * @return Deleted
23
23
  */
24
24
  deleteTenant(tenantId: string): Promise<void>;
25
25
  /**
26
26
  * Create new user in tenant
27
- * @tenantId Tenant Id
27
+ * @param tenantId Tenant Id
28
28
  * @return Created
29
29
  */
30
- createUserInTenant(body: {
31
- [key: string]: any;
32
- }, tenantId: string): Promise<UserId>;
30
+ createUserInTenant(body: User, tenantId: string): Promise<UserId>;
33
31
  /**
34
32
  * Update users passwords
35
- * @tenantId Tenant Id
33
+ * @param tenantId Tenant Id
36
34
  * @return Imported
37
35
  */
38
36
  updateUsersPasswords(body: UserPasswordHash[], tenantId: string): Promise<void>;
39
37
  /**
40
38
  * Set user claim values
41
- * @tenantId Tenant Id
42
- * @claimType Claim Type
39
+ * @param tenantId Tenant Id
40
+ * @param claimType Claim Type
43
41
  * @return OK
44
42
  */
45
43
  setUserClaims(userClaimsBatch: UserClaimsBatch[], tenantId: string, claimType: string): Promise<void>;
46
44
  /**
47
45
  * Import users in tenant
48
- * @tenantId Tenant Id
46
+ * @param tenantId Tenant Id
49
47
  * @return Imported
50
48
  */
51
49
  importUsersInTenant(body: UserImport[], tenantId: string): Promise<void>;
52
50
  /**
53
51
  * Get user from tenant
54
- * @tenantId Tenant Id
55
- * @userId User Id
52
+ * @param tenantId Tenant Id
53
+ * @param userId User Id
56
54
  * @return OK
57
55
  */
58
- getUserFromTenant(tenantId: string, userId: string): Promise<{
59
- [key: string]: any;
60
- }>;
56
+ getUserFromTenant(tenantId: string, userId: string): Promise<User>;
61
57
  /**
62
58
  * Update user in tenant
63
- * @tenantId Tenant Id
64
- * @userId User Id
59
+ * @param tenantId Tenant Id
60
+ * @param userId User Id
65
61
  * @return Updated
66
62
  */
67
63
  updateUserInTenant(body: UserPartial, tenantId: string, userId: string): Promise<void>;
68
64
  /**
69
65
  * Delete user from tenant
70
- * @tenantId Tenant Id
71
- * @userId User Id
66
+ * @param tenantId Tenant Id
67
+ * @param userId User Id
72
68
  * @return Deleted
73
69
  */
74
70
  deleteUserFromTenant(tenantId: string, userId: string): Promise<void>;
75
71
  /**
76
72
  * Change user's password
77
- * @tenantId Tenant Id
78
- * @userId User Id
73
+ * @param tenantId Tenant Id
74
+ * @param userId User Id
79
75
  * @return Updated
80
76
  */
81
77
  changeUserPasswordInTenant(body: Password, tenantId: string, userId: string): Promise<void>;
82
78
  /**
83
79
  * Create new external SAML identity provider in tenant
84
- * @tenantId Tenant Id
80
+ * @param tenantId Tenant Id
85
81
  * @return Created
86
82
  */
87
- createSamlProviderInTenant(body: {
88
- [key: string]: any;
89
- }, tenantId: string): Promise<SamlProviderId>;
83
+ createSamlProviderInTenant(body: SamlProvider, tenantId: string): Promise<SamlProviderId>;
90
84
  /**
91
85
  * Get all external SAML identity providers in tenant
92
- * @tenantId Tenant Id
86
+ * @param tenantId Tenant Id
93
87
  * @return OK
94
88
  */
95
- getSamlProvidersInTenant(tenantId: string): Promise<{
96
- [key: string]: any;
97
- }[]>;
89
+ getSamlProvidersInTenant(tenantId: string): Promise<SamlProvider[]>;
98
90
  /**
99
91
  * Get external SAML identity provider from tenant
100
- * @tenantId Tenant Id
92
+ * @param tenantId Tenant Id
93
+ * @param samlProviderId SAML Provider Id
101
94
  * @return OK
102
95
  */
103
- getSamlProviderFromTenant(tenantId: string): Promise<{
104
- [key: string]: any;
105
- }>;
96
+ getSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<SamlProvider>;
106
97
  /**
107
98
  * Update external SAML identity provider in tenant
108
- * @tenantId Tenant Id
99
+ * @param tenantId Tenant Id
100
+ * @param samlProviderId SAML Provider Id
109
101
  * @return Updated
110
102
  */
111
- updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string): Promise<void>;
103
+ updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string, samlProviderId: string): Promise<void>;
112
104
  /**
113
105
  * Delete external SAML identity provider from tenant
114
- * @tenantId Tenant Id
106
+ * @param tenantId Tenant Id
107
+ * @param samlProviderId SAML Provider Id
108
+ * @return Deleted
109
+ */
110
+ deleteSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<void>;
111
+ /**
112
+ * Create new Apptio Frontdoor identity provider in tenant
113
+ * @param tenantId Tenant Id
114
+ * @return Created
115
+ */
116
+ createFrontdoorProviderInTenant(body: FrontdoorProvider, tenantId: string): Promise<FrontdoorProviderId>;
117
+ /**
118
+ * Get all Apptio Frontdoor identity providers in tenant
119
+ * @param tenantId Tenant Id
120
+ * @return OK
121
+ */
122
+ getFrontdoorProvidersInTenant(tenantId: string): Promise<FrontdoorProvider[]>;
123
+ /**
124
+ * Get Apptio Frontdoor identity provider from tenant
125
+ * @param tenantId Tenant Id
126
+ * @param frontdoorProviderId Frontdoor Provider Id
127
+ * @return OK
128
+ */
129
+ getFrontdoorProviderFromTenant(tenantId: string, frontdoorProviderId: string): Promise<FrontdoorProvider>;
130
+ /**
131
+ * Update Apptio Frontdoor identity provider in tenant
132
+ * @param tenantId Tenant Id
133
+ * @param frontdoorProviderId Frontdoor Provider Id
134
+ * @return Updated
135
+ */
136
+ updateFrontdoorProviderInTenant(body: FrontdoorProviderPartial, tenantId: string, frontdoorProviderId: string): Promise<void>;
137
+ /**
138
+ * Delete Apptio Frontdoor identity provider from tenant
139
+ * @param tenantId Tenant Id
140
+ * @param frontdoorProviderId Frontdoor Provider Id
115
141
  * @return Deleted
116
142
  */
117
- deleteSamlProviderFromTenant(tenantId: string): Promise<void>;
143
+ deleteFrontdoorProviderFromTenant(tenantId: string, frontdoorProviderId: string): Promise<void>;
118
144
  /**
119
145
  * Create new external SSO profile in tenant
120
- * @tenantId Tenant Id
146
+ * @param tenantId Tenant Id
121
147
  * @return Created
122
148
  */
123
- createSsoProfileInTenant(body: {
124
- [key: string]: any;
125
- }, tenantId: string): Promise<SsoProfileId>;
149
+ createSsoProfileInTenant(body: SsoProfile, tenantId: string): Promise<SsoProfileId>;
126
150
  /**
127
151
  * Get external SSO profile from tenant
128
- * @tenantId Tenant Id
152
+ * @param tenantId Tenant Id
153
+ * @param ssoProfileId External SSO Profile Id
129
154
  * @return OK
130
155
  */
131
- getSsoProfileFromTenant(tenantId: string): Promise<{
132
- [key: string]: any;
133
- }>;
156
+ getSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<SsoProfile>;
134
157
  /**
135
158
  * Update external SSO profile in tenant
136
- * @tenantId Tenant Id
159
+ * @param tenantId Tenant Id
160
+ * @param ssoProfileId External SSO Profile Id
137
161
  * @return Updated
138
162
  */
139
- updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string): Promise<void>;
163
+ updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string, ssoProfileId: string): Promise<void>;
140
164
  /**
141
165
  * Delete external SSO profile from tenant
142
- * @tenantId Tenant Id
166
+ * @param tenantId Tenant Id
167
+ * @param ssoProfileId External SSO Profile Id
143
168
  * @return Deleted
144
169
  */
145
- deleteSsoProfileFromTenant(tenantId: string): Promise<void>;
170
+ deleteSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<void>;
146
171
  /**
147
172
  * Create new client
148
173
  * @return Created
@@ -150,19 +175,19 @@ export interface IAuthClient {
150
175
  createClient(body: Client): Promise<ClientCredentials>;
151
176
  /**
152
177
  * Update client
153
- * @clientId Client Id
178
+ * @param clientId Client Id
154
179
  * @return Updated
155
180
  */
156
181
  updateClient(body: ClientInfo, clientId: string): Promise<void>;
157
182
  /**
158
183
  * Get client
159
- * @clientId Client Id
184
+ * @param clientId Client Id
160
185
  * @return OK
161
186
  */
162
187
  getClient(clientId: string): Promise<ClientInfo>;
163
188
  /**
164
189
  * Delete client
165
- * @clientId Client Id
190
+ * @param clientId Client Id
166
191
  * @return Deleted
167
192
  */
168
193
  deleteClient(clientId: string): Promise<void>;
@@ -178,19 +203,19 @@ export interface IAuthClient {
178
203
  createApiResource(body: ApiResource): Promise<ApiResource>;
179
204
  /**
180
205
  * Get api resource
181
- * @resourceName Api resource name
206
+ * @param resourceName Api resource name
182
207
  * @return OK
183
208
  */
184
209
  getApiResource(resourceName: string): Promise<ApiResource>;
185
210
  /**
186
211
  * Delete api resources
187
- * @resourceName Api resource name
212
+ * @param resourceName Api resource name
188
213
  * @return OK
189
214
  */
190
215
  deleteApiResource(resourceName: string): Promise<void>;
191
216
  /**
192
217
  * Update api resource
193
- * @resourceName Api resource name
218
+ * @param resourceName Api resource name
194
219
  * @return OK
195
220
  */
196
221
  updateApiResource(body: ApiResource, resourceName: string): Promise<void>;
@@ -210,170 +235,192 @@ export declare class AuthClient implements IAuthClient {
210
235
  protected processCreateTenant(response: Response): Promise<TenantId>;
211
236
  /**
212
237
  * Update tenant
213
- * @tenantId Tenant Id
238
+ * @param tenantId Tenant Id
214
239
  * @return Updated
215
240
  */
216
241
  updateTenant(body: Tenant, tenantId: string): Promise<void>;
217
242
  protected processUpdateTenant(response: Response): Promise<void>;
218
243
  /**
219
244
  * Get tenant details
220
- * @tenantId Tenant Id
245
+ * @param tenantId Tenant Id
221
246
  * @return OK
222
247
  */
223
248
  getTenant(tenantId: string): Promise<Tenant>;
224
249
  protected processGetTenant(response: Response): Promise<Tenant>;
225
250
  /**
226
251
  * Delete tenant
227
- * @tenantId Tenant Id
252
+ * @param tenantId Tenant Id
228
253
  * @return Deleted
229
254
  */
230
255
  deleteTenant(tenantId: string): Promise<void>;
231
256
  protected processDeleteTenant(response: Response): Promise<void>;
232
257
  /**
233
258
  * Create new user in tenant
234
- * @tenantId Tenant Id
259
+ * @param tenantId Tenant Id
235
260
  * @return Created
236
261
  */
237
- createUserInTenant(body: {
238
- [key: string]: any;
239
- }, tenantId: string): Promise<UserId>;
262
+ createUserInTenant(body: User, tenantId: string): Promise<UserId>;
240
263
  protected processCreateUserInTenant(response: Response): Promise<UserId>;
241
264
  /**
242
265
  * Update users passwords
243
- * @tenantId Tenant Id
266
+ * @param tenantId Tenant Id
244
267
  * @return Imported
245
268
  */
246
269
  updateUsersPasswords(body: UserPasswordHash[], tenantId: string): Promise<void>;
247
270
  protected processUpdateUsersPasswords(response: Response): Promise<void>;
248
271
  /**
249
272
  * Set user claim values
250
- * @tenantId Tenant Id
251
- * @claimType Claim Type
273
+ * @param tenantId Tenant Id
274
+ * @param claimType Claim Type
252
275
  * @return OK
253
276
  */
254
277
  setUserClaims(userClaimsBatch: UserClaimsBatch[], tenantId: string, claimType: string): Promise<void>;
255
278
  protected processSetUserClaims(response: Response): Promise<void>;
256
279
  /**
257
280
  * Import users in tenant
258
- * @tenantId Tenant Id
281
+ * @param tenantId Tenant Id
259
282
  * @return Imported
260
283
  */
261
284
  importUsersInTenant(body: UserImport[], tenantId: string): Promise<void>;
262
285
  protected processImportUsersInTenant(response: Response): Promise<void>;
263
286
  /**
264
287
  * Get user from tenant
265
- * @tenantId Tenant Id
266
- * @userId User Id
288
+ * @param tenantId Tenant Id
289
+ * @param userId User Id
267
290
  * @return OK
268
291
  */
269
- getUserFromTenant(tenantId: string, userId: string): Promise<{
270
- [key: string]: any;
271
- }>;
272
- protected processGetUserFromTenant(response: Response): Promise<{
273
- [key: string]: any;
274
- }>;
292
+ getUserFromTenant(tenantId: string, userId: string): Promise<User>;
293
+ protected processGetUserFromTenant(response: Response): Promise<User>;
275
294
  /**
276
295
  * Update user in tenant
277
- * @tenantId Tenant Id
278
- * @userId User Id
296
+ * @param tenantId Tenant Id
297
+ * @param userId User Id
279
298
  * @return Updated
280
299
  */
281
300
  updateUserInTenant(body: UserPartial, tenantId: string, userId: string): Promise<void>;
282
301
  protected processUpdateUserInTenant(response: Response): Promise<void>;
283
302
  /**
284
303
  * Delete user from tenant
285
- * @tenantId Tenant Id
286
- * @userId User Id
304
+ * @param tenantId Tenant Id
305
+ * @param userId User Id
287
306
  * @return Deleted
288
307
  */
289
308
  deleteUserFromTenant(tenantId: string, userId: string): Promise<void>;
290
309
  protected processDeleteUserFromTenant(response: Response): Promise<void>;
291
310
  /**
292
311
  * Change user's password
293
- * @tenantId Tenant Id
294
- * @userId User Id
312
+ * @param tenantId Tenant Id
313
+ * @param userId User Id
295
314
  * @return Updated
296
315
  */
297
316
  changeUserPasswordInTenant(body: Password, tenantId: string, userId: string): Promise<void>;
298
317
  protected processChangeUserPasswordInTenant(response: Response): Promise<void>;
299
318
  /**
300
319
  * Create new external SAML identity provider in tenant
301
- * @tenantId Tenant Id
320
+ * @param tenantId Tenant Id
302
321
  * @return Created
303
322
  */
304
- createSamlProviderInTenant(body: {
305
- [key: string]: any;
306
- }, tenantId: string): Promise<SamlProviderId>;
323
+ createSamlProviderInTenant(body: SamlProvider, tenantId: string): Promise<SamlProviderId>;
307
324
  protected processCreateSamlProviderInTenant(response: Response): Promise<SamlProviderId>;
308
325
  /**
309
326
  * Get all external SAML identity providers in tenant
310
- * @tenantId Tenant Id
327
+ * @param tenantId Tenant Id
311
328
  * @return OK
312
329
  */
313
- getSamlProvidersInTenant(tenantId: string): Promise<{
314
- [key: string]: any;
315
- }[]>;
316
- protected processGetSamlProvidersInTenant(response: Response): Promise<{
317
- [key: string]: any;
318
- }[]>;
330
+ getSamlProvidersInTenant(tenantId: string): Promise<SamlProvider[]>;
331
+ protected processGetSamlProvidersInTenant(response: Response): Promise<SamlProvider[]>;
319
332
  /**
320
333
  * Get external SAML identity provider from tenant
321
- * @tenantId Tenant Id
334
+ * @param tenantId Tenant Id
335
+ * @param samlProviderId SAML Provider Id
322
336
  * @return OK
323
337
  */
324
- getSamlProviderFromTenant(tenantId: string): Promise<{
325
- [key: string]: any;
326
- }>;
327
- protected processGetSamlProviderFromTenant(response: Response): Promise<{
328
- [key: string]: any;
329
- }>;
338
+ getSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<SamlProvider>;
339
+ protected processGetSamlProviderFromTenant(response: Response): Promise<SamlProvider>;
330
340
  /**
331
341
  * Update external SAML identity provider in tenant
332
- * @tenantId Tenant Id
342
+ * @param tenantId Tenant Id
343
+ * @param samlProviderId SAML Provider Id
333
344
  * @return Updated
334
345
  */
335
- updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string): Promise<void>;
346
+ updateSamlProviderInTenant(body: SamlProviderPartial, tenantId: string, samlProviderId: string): Promise<void>;
336
347
  protected processUpdateSamlProviderInTenant(response: Response): Promise<void>;
337
348
  /**
338
349
  * Delete external SAML identity provider from tenant
339
- * @tenantId Tenant Id
350
+ * @param tenantId Tenant Id
351
+ * @param samlProviderId SAML Provider Id
340
352
  * @return Deleted
341
353
  */
342
- deleteSamlProviderFromTenant(tenantId: string): Promise<void>;
354
+ deleteSamlProviderFromTenant(tenantId: string, samlProviderId: string): Promise<void>;
343
355
  protected processDeleteSamlProviderFromTenant(response: Response): Promise<void>;
356
+ /**
357
+ * Create new Apptio Frontdoor identity provider in tenant
358
+ * @param tenantId Tenant Id
359
+ * @return Created
360
+ */
361
+ createFrontdoorProviderInTenant(body: FrontdoorProvider, tenantId: string): Promise<FrontdoorProviderId>;
362
+ protected processCreateFrontdoorProviderInTenant(response: Response): Promise<FrontdoorProviderId>;
363
+ /**
364
+ * Get all Apptio Frontdoor identity providers in tenant
365
+ * @param tenantId Tenant Id
366
+ * @return OK
367
+ */
368
+ getFrontdoorProvidersInTenant(tenantId: string): Promise<FrontdoorProvider[]>;
369
+ protected processGetFrontdoorProvidersInTenant(response: Response): Promise<FrontdoorProvider[]>;
370
+ /**
371
+ * Get Apptio Frontdoor identity provider from tenant
372
+ * @param tenantId Tenant Id
373
+ * @param frontdoorProviderId Frontdoor Provider Id
374
+ * @return OK
375
+ */
376
+ getFrontdoorProviderFromTenant(tenantId: string, frontdoorProviderId: string): Promise<FrontdoorProvider>;
377
+ protected processGetFrontdoorProviderFromTenant(response: Response): Promise<FrontdoorProvider>;
378
+ /**
379
+ * Update Apptio Frontdoor identity provider in tenant
380
+ * @param tenantId Tenant Id
381
+ * @param frontdoorProviderId Frontdoor Provider Id
382
+ * @return Updated
383
+ */
384
+ updateFrontdoorProviderInTenant(body: FrontdoorProviderPartial, tenantId: string, frontdoorProviderId: string): Promise<void>;
385
+ protected processUpdateFrontdoorProviderInTenant(response: Response): Promise<void>;
386
+ /**
387
+ * Delete Apptio Frontdoor identity provider from tenant
388
+ * @param tenantId Tenant Id
389
+ * @param frontdoorProviderId Frontdoor Provider Id
390
+ * @return Deleted
391
+ */
392
+ deleteFrontdoorProviderFromTenant(tenantId: string, frontdoorProviderId: string): Promise<void>;
393
+ protected processDeleteFrontdoorProviderFromTenant(response: Response): Promise<void>;
344
394
  /**
345
395
  * Create new external SSO profile in tenant
346
- * @tenantId Tenant Id
396
+ * @param tenantId Tenant Id
347
397
  * @return Created
348
398
  */
349
- createSsoProfileInTenant(body: {
350
- [key: string]: any;
351
- }, tenantId: string): Promise<SsoProfileId>;
399
+ createSsoProfileInTenant(body: SsoProfile, tenantId: string): Promise<SsoProfileId>;
352
400
  protected processCreateSsoProfileInTenant(response: Response): Promise<SsoProfileId>;
353
401
  /**
354
402
  * Get external SSO profile from tenant
355
- * @tenantId Tenant Id
403
+ * @param tenantId Tenant Id
404
+ * @param ssoProfileId External SSO Profile Id
356
405
  * @return OK
357
406
  */
358
- getSsoProfileFromTenant(tenantId: string): Promise<{
359
- [key: string]: any;
360
- }>;
361
- protected processGetSsoProfileFromTenant(response: Response): Promise<{
362
- [key: string]: any;
363
- }>;
407
+ getSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<SsoProfile>;
408
+ protected processGetSsoProfileFromTenant(response: Response): Promise<SsoProfile>;
364
409
  /**
365
410
  * Update external SSO profile in tenant
366
- * @tenantId Tenant Id
411
+ * @param tenantId Tenant Id
412
+ * @param ssoProfileId External SSO Profile Id
367
413
  * @return Updated
368
414
  */
369
- updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string): Promise<void>;
415
+ updateSsoProfileInTenant(body: SsoProfilePartial, tenantId: string, ssoProfileId: string): Promise<void>;
370
416
  protected processUpdateSsoProfileInTenant(response: Response): Promise<void>;
371
417
  /**
372
418
  * Delete external SSO profile from tenant
373
- * @tenantId Tenant Id
419
+ * @param tenantId Tenant Id
420
+ * @param ssoProfileId External SSO Profile Id
374
421
  * @return Deleted
375
422
  */
376
- deleteSsoProfileFromTenant(tenantId: string): Promise<void>;
423
+ deleteSsoProfileFromTenant(tenantId: string, ssoProfileId: string): Promise<void>;
377
424
  protected processDeleteSsoProfileFromTenant(response: Response): Promise<void>;
378
425
  /**
379
426
  * Create new client
@@ -383,21 +430,21 @@ export declare class AuthClient implements IAuthClient {
383
430
  protected processCreateClient(response: Response): Promise<ClientCredentials>;
384
431
  /**
385
432
  * Update client
386
- * @clientId Client Id
433
+ * @param clientId Client Id
387
434
  * @return Updated
388
435
  */
389
436
  updateClient(body: ClientInfo, clientId: string): Promise<void>;
390
437
  protected processUpdateClient(response: Response): Promise<void>;
391
438
  /**
392
439
  * Get client
393
- * @clientId Client Id
440
+ * @param clientId Client Id
394
441
  * @return OK
395
442
  */
396
443
  getClient(clientId: string): Promise<ClientInfo>;
397
444
  protected processGetClient(response: Response): Promise<ClientInfo>;
398
445
  /**
399
446
  * Delete client
400
- * @clientId Client Id
447
+ * @param clientId Client Id
401
448
  * @return Deleted
402
449
  */
403
450
  deleteClient(clientId: string): Promise<void>;
@@ -416,21 +463,21 @@ export declare class AuthClient implements IAuthClient {
416
463
  protected processCreateApiResource(response: Response): Promise<ApiResource>;
417
464
  /**
418
465
  * Get api resource
419
- * @resourceName Api resource name
466
+ * @param resourceName Api resource name
420
467
  * @return OK
421
468
  */
422
469
  getApiResource(resourceName: string): Promise<ApiResource>;
423
470
  protected processGetApiResource(response: Response): Promise<ApiResource>;
424
471
  /**
425
472
  * Delete api resources
426
- * @resourceName Api resource name
473
+ * @param resourceName Api resource name
427
474
  * @return OK
428
475
  */
429
476
  deleteApiResource(resourceName: string): Promise<void>;
430
477
  protected processDeleteApiResource(response: Response): Promise<void>;
431
478
  /**
432
479
  * Update api resource
433
- * @resourceName Api resource name
480
+ * @param resourceName Api resource name
434
481
  * @return OK
435
482
  */
436
483
  updateApiResource(body: ApiResource, resourceName: string): Promise<void>;
@@ -461,20 +508,21 @@ export interface UserPartial {
461
508
  email?: string | undefined;
462
509
  claims?: Claim[] | undefined;
463
510
  }
511
+ export interface User extends UserPartial {
512
+ }
464
513
  /** user password hash algorithm */
465
514
  export declare enum PasswordHashAlgorithm {
466
- Unknown,
467
- ProprietaryV1,
468
- IdentityV3,
515
+ Unknown = "Unknown",
516
+ ProprietaryV1 = "ProprietaryV1",
517
+ IdentityV3 = "IdentityV3",
469
518
  }
470
- export interface UserImport {
519
+ export interface UserImport extends User {
471
520
  /** User's globally unique identifier */
472
521
  id: string;
473
522
  /** User's password hash */
474
523
  passwordHash?: string | undefined;
475
524
  /** User's password hash algorithm */
476
525
  passwordHashAlgorithm?: PasswordHashAlgorithm | undefined;
477
- [key: string]: any;
478
526
  }
479
527
  export interface UserPasswordHash extends UserId {
480
528
  /** User's password hash */
@@ -604,6 +652,8 @@ export interface SamlProviderPartial {
604
652
  /** Issuer */
605
653
  issuer?: string | undefined;
606
654
  }
655
+ export interface SamlProvider extends SamlProviderPartial {
656
+ }
607
657
  export interface SsoProfileId {
608
658
  /** External SSO profile's globally unique identifier */
609
659
  id: string;
@@ -622,6 +672,24 @@ export interface SsoProfilePartial {
622
672
  /** List of external provider (both SAML2 and OAuth) ids to use for login */
623
673
  providers?: string[] | undefined;
624
674
  }
675
+ export interface SsoProfile extends SsoProfilePartial {
676
+ }
677
+ export interface FrontdoorProviderPartial {
678
+ /** Frontdoor provider display name */
679
+ displayName?: string | undefined;
680
+ /** Frontdoor service base url, should have https schema */
681
+ baseUrl?: string | undefined;
682
+ /** Id of the application created */
683
+ applicationId?: string | undefined;
684
+ /** Id of the environment where applicationId is entitled */
685
+ environmentId?: string | undefined;
686
+ }
687
+ export interface FrontdoorProvider extends FrontdoorProviderPartial {
688
+ }
689
+ export interface FrontdoorProviderId {
690
+ /** External Frontdoor identity provider's globally unique identifier */
691
+ id: string;
692
+ }
625
693
  export interface ErrorDto {
626
694
  /** Internal error code */
627
695
  code?: string | undefined;
@@ -633,26 +701,26 @@ export interface UserClaimsBatch {
633
701
  claimValues?: string[] | undefined;
634
702
  }
635
703
  export declare enum AllowedGrantTypes {
636
- Authorization_code,
637
- Implicit,
638
- Hybrid,
639
- Password,
640
- Client_credentials,
641
- Delegation,
704
+ Authorization_code = "authorization_code",
705
+ Implicit = "implicit",
706
+ Hybrid = "hybrid",
707
+ Password = "password",
708
+ Client_credentials = "client_credentials",
709
+ Delegation = "delegation",
642
710
  }
643
711
  export declare enum ClientInfoRefreshTokenUsage {
644
- ReUse,
645
- OneTimeOnly,
712
+ ReUse = "reUse",
713
+ OneTimeOnly = "oneTimeOnly",
646
714
  }
647
715
  export declare enum ClientInfoRefreshTokenExpiration {
648
- Absolute,
649
- Sliding,
716
+ Absolute = "absolute",
717
+ Sliding = "sliding",
650
718
  }
651
719
  export declare enum ClientInfoAccessTokenType {
652
- Jwt,
653
- Reference,
720
+ Jwt = "jwt",
721
+ Reference = "reference",
654
722
  }
655
- export declare class SwaggerException extends Error {
723
+ export declare class ApiException extends Error {
656
724
  message: string;
657
725
  status: number;
658
726
  response: string;
@@ -663,6 +731,6 @@ export declare class SwaggerException extends Error {
663
731
  constructor(message: string, status: number, response: string, headers: {
664
732
  [key: string]: any;
665
733
  }, result: any);
666
- protected isSwaggerException: boolean;
667
- static isSwaggerException(obj: any): obj is SwaggerException;
734
+ protected isApiException: boolean;
735
+ static isApiException(obj: any): obj is ApiException;
668
736
  }