@dfns/sdk 0.4.1 → 0.4.2
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/baseAuthApi.d.ts +4 -2
- package/codegen/datamodel/Auth/types.d.ts +316 -1
- package/codegen/datamodel/Auth/types.js +33 -11
- package/codegen/datamodel/Foundations/types.d.ts +36 -0
- package/codegen/datamodel/Foundations/types.js +12 -4
- package/codegen/datamodel/Wallets/types.d.ts +6 -0
- package/codegen/datamodel/Wallets/types.js +12 -0
- package/dfnsApiClient.d.ts +3 -2
- package/dfnsApiClient.js +2 -2
- package/dfnsDelegatedApiClient.d.ts +2 -4
- package/dfnsDelegatedApiClient.js +2 -2
- package/generated/auth/client.d.ts +79 -0
- package/generated/auth/client.js +677 -0
- package/generated/auth/delegatedClient.d.ts +99 -0
- package/generated/auth/delegatedClient.js +1093 -0
- package/generated/auth/index.d.ts +3 -0
- package/generated/auth/index.js +19 -0
- package/generated/auth/types.d.ts +1983 -0
- package/generated/auth/types.js +2 -0
- package/generated/networks/types.d.ts +33 -7
- package/generated/permissions/types.d.ts +16 -26
- package/generated/wallets/types.d.ts +13 -1
- package/package.json +1 -1
- package/signer.d.ts +1 -2
- package/types/auth.d.ts +1 -0
- package/types/auth.js +17 -0
- package/utils/fetch.js +9 -1
|
@@ -1,15 +1,27 @@
|
|
|
1
1
|
import { Email, EntityId, IntegerPositiveStrict, IsoDatetime, Username } from '../Foundations';
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
4
|
+
*/
|
|
2
5
|
export type Application = {
|
|
3
6
|
appId: EntityId;
|
|
4
7
|
apiToken?: Jwt;
|
|
5
8
|
};
|
|
9
|
+
/**
|
|
10
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
11
|
+
*/
|
|
6
12
|
export type GenericSuccessMessage = {
|
|
7
13
|
message: string;
|
|
8
14
|
};
|
|
15
|
+
/**
|
|
16
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
17
|
+
*/
|
|
9
18
|
export type UserRegistration = {
|
|
10
19
|
credential: UserCredentialInformation;
|
|
11
20
|
user: UserRegistrationInformation;
|
|
12
21
|
};
|
|
22
|
+
/**
|
|
23
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
24
|
+
*/
|
|
13
25
|
export type UserRegistrationChallenge = {
|
|
14
26
|
temporaryAuthenticationToken: Jwt;
|
|
15
27
|
rp: RelyingParty;
|
|
@@ -22,6 +34,9 @@ export type UserRegistrationChallenge = {
|
|
|
22
34
|
pubKeyCredParams: PubKeyCredParams[];
|
|
23
35
|
excludeCredentials: AllowCredential[];
|
|
24
36
|
};
|
|
37
|
+
/**
|
|
38
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
39
|
+
*/
|
|
25
40
|
export type UserLoginChallenge = {
|
|
26
41
|
supportedCredentialKinds: SupportedCredentials[];
|
|
27
42
|
rp: RelyingParty;
|
|
@@ -32,12 +47,21 @@ export type UserLoginChallenge = {
|
|
|
32
47
|
attestation: AuthenticatorAttestationOptions;
|
|
33
48
|
userVerification: AuthenticatorRequirementOptions;
|
|
34
49
|
};
|
|
50
|
+
/**
|
|
51
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
52
|
+
*/
|
|
35
53
|
export type UserLogin = {
|
|
36
54
|
token: Jwt;
|
|
37
55
|
};
|
|
56
|
+
/**
|
|
57
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
58
|
+
*/
|
|
38
59
|
export type UserActionSignature = {
|
|
39
60
|
userAction: string;
|
|
40
61
|
};
|
|
62
|
+
/**
|
|
63
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
64
|
+
*/
|
|
41
65
|
export type AccessTokenInfoWithPublicKey = {
|
|
42
66
|
accessToken?: Jwt;
|
|
43
67
|
dateCreated: IsoDatetime;
|
|
@@ -52,6 +76,9 @@ export type AccessTokenInfoWithPublicKey = {
|
|
|
52
76
|
publicKey: string;
|
|
53
77
|
tokenId: EntityId;
|
|
54
78
|
};
|
|
79
|
+
/**
|
|
80
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
81
|
+
*/
|
|
55
82
|
export type UserInfo = {
|
|
56
83
|
username: string;
|
|
57
84
|
userId: EntityId;
|
|
@@ -65,10 +92,16 @@ export type UserInfo = {
|
|
|
65
92
|
isRegistered: boolean;
|
|
66
93
|
permissionAssignments: PermissionAssignmentInfo[];
|
|
67
94
|
};
|
|
95
|
+
/**
|
|
96
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
97
|
+
*/
|
|
68
98
|
export type UserAccessTokenInformation = {
|
|
69
99
|
userInfo: UserInfo;
|
|
70
100
|
accessTokens: AccessTokenInfoWithPublicKey[];
|
|
71
101
|
};
|
|
102
|
+
/**
|
|
103
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
104
|
+
*/
|
|
72
105
|
export type AppInfoWithPublicKey = {
|
|
73
106
|
appId: EntityId;
|
|
74
107
|
kind: ApplicationKind;
|
|
@@ -80,6 +113,9 @@ export type AppInfoWithPublicKey = {
|
|
|
80
113
|
permissionAssignments: PermissionAssignmentInfo[];
|
|
81
114
|
accessTokens: AccessTokenInfoWithPublicKey[];
|
|
82
115
|
};
|
|
116
|
+
/**
|
|
117
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
118
|
+
*/
|
|
83
119
|
export type CredentialInfo = {
|
|
84
120
|
credentialId: string;
|
|
85
121
|
credentialUuid: EntityId;
|
|
@@ -91,6 +127,9 @@ export type CredentialInfo = {
|
|
|
91
127
|
relyingPartyId: string;
|
|
92
128
|
origin: string;
|
|
93
129
|
};
|
|
130
|
+
/**
|
|
131
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
132
|
+
*/
|
|
94
133
|
export type AvailableOrg = {
|
|
95
134
|
/**
|
|
96
135
|
* The ID of the organization.
|
|
@@ -101,6 +140,9 @@ export type AvailableOrg = {
|
|
|
101
140
|
*/
|
|
102
141
|
appId: EntityId;
|
|
103
142
|
};
|
|
143
|
+
/**
|
|
144
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
145
|
+
*/
|
|
104
146
|
export type UserRecoveryChallenge = {
|
|
105
147
|
temporaryAuthenticationToken: Jwt;
|
|
106
148
|
rp: RelyingParty;
|
|
@@ -114,11 +156,17 @@ export type UserRecoveryChallenge = {
|
|
|
114
156
|
excludeCredentials: AllowCredential[];
|
|
115
157
|
allowedRecoveryCredentials: AllowRecoveryCredential[];
|
|
116
158
|
};
|
|
159
|
+
/**
|
|
160
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
161
|
+
*/
|
|
117
162
|
export type UserRegistrationBase = {
|
|
118
163
|
temporaryAuthenticationToken: Jwt;
|
|
119
164
|
rp: RelyingParty;
|
|
120
165
|
user: AuthenticationUserInformation;
|
|
121
166
|
};
|
|
167
|
+
/**
|
|
168
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
169
|
+
*/
|
|
122
170
|
export type Fido2Options = {
|
|
123
171
|
temporaryAuthenticationToken: Jwt;
|
|
124
172
|
rp: RelyingParty;
|
|
@@ -141,6 +189,9 @@ export type Fido2Options = {
|
|
|
141
189
|
attestation: AuthenticatorAttestationOptions;
|
|
142
190
|
pubKeyCredParams: PubKeyCredParams[];
|
|
143
191
|
};
|
|
192
|
+
/**
|
|
193
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
194
|
+
*/
|
|
144
195
|
export type PublicKeyOptions = {
|
|
145
196
|
temporaryAuthenticationToken: Jwt;
|
|
146
197
|
rp: RelyingParty;
|
|
@@ -150,6 +201,9 @@ export type PublicKeyOptions = {
|
|
|
150
201
|
pubKeyCredParams: PubKeyCredParams[];
|
|
151
202
|
attestation: AuthenticatorAttestationOptions;
|
|
152
203
|
};
|
|
204
|
+
/**
|
|
205
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
206
|
+
*/
|
|
153
207
|
export type AllowCredential = {
|
|
154
208
|
/**
|
|
155
209
|
* Must be 'public-key'
|
|
@@ -158,15 +212,24 @@ export type AllowCredential = {
|
|
|
158
212
|
id: string;
|
|
159
213
|
transports?: string;
|
|
160
214
|
};
|
|
215
|
+
/**
|
|
216
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
217
|
+
*/
|
|
161
218
|
export type RelyingParty = {
|
|
162
219
|
id: string;
|
|
163
220
|
name: string;
|
|
164
221
|
};
|
|
222
|
+
/**
|
|
223
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
224
|
+
*/
|
|
165
225
|
export type AuthenticationUserInformation = {
|
|
166
226
|
id: EntityId;
|
|
167
227
|
displayName: string;
|
|
168
228
|
name: string;
|
|
169
229
|
};
|
|
230
|
+
/**
|
|
231
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
232
|
+
*/
|
|
170
233
|
export type PubKeyCredParams = {
|
|
171
234
|
/**
|
|
172
235
|
* Must be 'public-key'
|
|
@@ -174,6 +237,9 @@ export type PubKeyCredParams = {
|
|
|
174
237
|
type: string;
|
|
175
238
|
alg: number;
|
|
176
239
|
};
|
|
240
|
+
/**
|
|
241
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
242
|
+
*/
|
|
177
243
|
export type AuthenticatorSelection = {
|
|
178
244
|
/**
|
|
179
245
|
* If not given, any authenticator type can be used.
|
|
@@ -202,6 +268,9 @@ export type AuthenticatorSelection = {
|
|
|
202
268
|
*/
|
|
203
269
|
userVerification: AuthenticatorRequirementOptions;
|
|
204
270
|
};
|
|
271
|
+
/**
|
|
272
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
273
|
+
*/
|
|
205
274
|
export type ExcludeCredentials = {
|
|
206
275
|
/**
|
|
207
276
|
* Must be 'public-key'
|
|
@@ -210,90 +279,150 @@ export type ExcludeCredentials = {
|
|
|
210
279
|
id: string;
|
|
211
280
|
transports: FidoCredentialsTransportKind;
|
|
212
281
|
};
|
|
282
|
+
/**
|
|
283
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
284
|
+
*/
|
|
213
285
|
export type UserCredentialInformation = {
|
|
214
286
|
uuid: EntityId;
|
|
215
287
|
kind: CredentialKind;
|
|
216
288
|
name: string;
|
|
217
289
|
};
|
|
290
|
+
/**
|
|
291
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
292
|
+
*/
|
|
218
293
|
export type UserRegistrationInformation = {
|
|
219
294
|
id: EntityId;
|
|
220
295
|
username: string;
|
|
221
296
|
orgId: EntityId;
|
|
222
297
|
};
|
|
298
|
+
/**
|
|
299
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
300
|
+
*/
|
|
223
301
|
export type AuthenticateUserPasswordInput = {
|
|
224
302
|
kind: CredentialKind.Password;
|
|
225
303
|
password: string;
|
|
226
304
|
};
|
|
305
|
+
/**
|
|
306
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
307
|
+
*/
|
|
227
308
|
export type AuthenticateUserFido2Input = {
|
|
228
309
|
kind: CredentialKind.Fido2;
|
|
229
310
|
credentialAssertion: Fido2CredentialAssertion;
|
|
230
311
|
};
|
|
312
|
+
/**
|
|
313
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
314
|
+
*/
|
|
231
315
|
export type Fido2CredentialAssertion = {
|
|
232
316
|
credId: string;
|
|
233
317
|
clientData: string;
|
|
234
318
|
authenticatorData: string;
|
|
235
319
|
signature: string;
|
|
236
|
-
userHandle
|
|
320
|
+
userHandle?: string;
|
|
237
321
|
};
|
|
322
|
+
/**
|
|
323
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
324
|
+
*/
|
|
238
325
|
export type KeyCredentialAssertion = {
|
|
239
326
|
credId: string;
|
|
240
327
|
clientData: string;
|
|
241
328
|
signature: string;
|
|
242
329
|
algorithm?: string;
|
|
243
330
|
};
|
|
331
|
+
/**
|
|
332
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
333
|
+
*/
|
|
244
334
|
export type AuthenticateUserKeyInput = {
|
|
245
335
|
kind: CredentialKind.Key;
|
|
246
336
|
credentialAssertion: KeyCredentialAssertion;
|
|
247
337
|
};
|
|
338
|
+
/**
|
|
339
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
340
|
+
*/
|
|
248
341
|
export type SupportedCredentialKinds = {
|
|
249
342
|
firstFactor: CredentialKind[];
|
|
250
343
|
secondFactor: CredentialKind[];
|
|
251
344
|
};
|
|
345
|
+
/**
|
|
346
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
347
|
+
*/
|
|
252
348
|
export type RegistrationConfirmationFido2 = {
|
|
253
349
|
credentialKind: CredentialKind.Fido2;
|
|
254
350
|
credentialInfo: CredentialAssertion;
|
|
255
351
|
};
|
|
352
|
+
/**
|
|
353
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
354
|
+
*/
|
|
256
355
|
export type RegistrationConfirmationKey = {
|
|
257
356
|
credentialKind: CredentialKind.Key;
|
|
258
357
|
credentialInfo: CredentialAssertion;
|
|
259
358
|
};
|
|
359
|
+
/**
|
|
360
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
361
|
+
*/
|
|
260
362
|
export type RegistrationConfirmationRecoveryKey = {
|
|
261
363
|
encryptedPrivateKey?: string;
|
|
262
364
|
credentialInfo: CredentialAssertion;
|
|
263
365
|
credentialKind: CredentialKind.RecoveryKey;
|
|
264
366
|
};
|
|
367
|
+
/**
|
|
368
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
369
|
+
*/
|
|
265
370
|
export type CredentialAssertion = {
|
|
266
371
|
credId: string;
|
|
267
372
|
clientData: string;
|
|
268
373
|
attestationData: string;
|
|
269
374
|
};
|
|
375
|
+
/**
|
|
376
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
377
|
+
*/
|
|
270
378
|
export type RegistrationConfirmationPassword = {
|
|
271
379
|
credentialKind: CredentialKind.Password;
|
|
272
380
|
credentialInfo: PasswordCredentialInformation;
|
|
273
381
|
};
|
|
382
|
+
/**
|
|
383
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
384
|
+
*/
|
|
274
385
|
export type PasswordCredentialInformation = {
|
|
275
386
|
password: string;
|
|
276
387
|
};
|
|
388
|
+
/**
|
|
389
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
390
|
+
*/
|
|
277
391
|
export type RegistrationConfirmationTotp = {
|
|
278
392
|
credentialKind: CredentialKind.Totp;
|
|
279
393
|
credentialInfo: TotpCredentialInformation;
|
|
280
394
|
};
|
|
395
|
+
/**
|
|
396
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
397
|
+
*/
|
|
281
398
|
export type TotpCredentialInformation = {
|
|
282
399
|
otpCode: string;
|
|
283
400
|
};
|
|
401
|
+
/**
|
|
402
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
403
|
+
*/
|
|
284
404
|
export type AllowCredentials = {
|
|
285
405
|
webauthn: AllowCredential[];
|
|
286
406
|
key: AllowCredential[];
|
|
287
407
|
};
|
|
408
|
+
/**
|
|
409
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
410
|
+
*/
|
|
288
411
|
export type SupportedCredentials = {
|
|
289
412
|
kind: CredentialKind;
|
|
290
413
|
factor: CredentialFactor;
|
|
291
414
|
requiresSecondFactor: boolean;
|
|
292
415
|
};
|
|
416
|
+
/**
|
|
417
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
418
|
+
*/
|
|
293
419
|
export type AuthenticateUserTotpInput = {
|
|
294
420
|
kind: CredentialKind.Totp;
|
|
295
421
|
otpCode: string;
|
|
296
422
|
};
|
|
423
|
+
/**
|
|
424
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
425
|
+
*/
|
|
297
426
|
export type TotpCredential = {
|
|
298
427
|
temporaryAuthenticationToken: Jwt;
|
|
299
428
|
rp: RelyingParty;
|
|
@@ -301,51 +430,78 @@ export type TotpCredential = {
|
|
|
301
430
|
kind: CredentialKind.Totp;
|
|
302
431
|
otpUrl: string;
|
|
303
432
|
};
|
|
433
|
+
/**
|
|
434
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
435
|
+
*/
|
|
304
436
|
export type PasswordCredential = {
|
|
305
437
|
temporaryAuthenticationToken: Jwt;
|
|
306
438
|
rp: RelyingParty;
|
|
307
439
|
user: AuthenticationUserInformation;
|
|
308
440
|
kind: CredentialKind.Password;
|
|
309
441
|
};
|
|
442
|
+
/**
|
|
443
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
444
|
+
*/
|
|
310
445
|
export type CreateUserCredentialInputBase = {
|
|
311
446
|
challengeIdentifier: Jwt;
|
|
312
447
|
credentialName: string;
|
|
313
448
|
};
|
|
449
|
+
/**
|
|
450
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
451
|
+
*/
|
|
314
452
|
export type CreateUserCredentialTotpInput = {
|
|
315
453
|
challengeIdentifier: Jwt;
|
|
316
454
|
credentialName: string;
|
|
317
455
|
credentialKind: CredentialKind.Totp;
|
|
318
456
|
credentialInfo: TotpCredentialInformation;
|
|
319
457
|
};
|
|
458
|
+
/**
|
|
459
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
460
|
+
*/
|
|
320
461
|
export type CreateUserCredentialPasswordInput = {
|
|
321
462
|
credentialKind: CredentialKind.Password;
|
|
322
463
|
credentialInfo: PasswordCredentialInformation;
|
|
323
464
|
challengeIdentifier: Jwt;
|
|
324
465
|
credentialName: string;
|
|
325
466
|
};
|
|
467
|
+
/**
|
|
468
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
469
|
+
*/
|
|
326
470
|
export type CreateUserCredentialPublicKeyInput = {
|
|
327
471
|
challengeIdentifier: Jwt;
|
|
328
472
|
credentialName: string;
|
|
329
473
|
credentialKind: CredentialKind.Key;
|
|
330
474
|
credentialInfo: CredentialAssertion;
|
|
331
475
|
};
|
|
476
|
+
/**
|
|
477
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
478
|
+
*/
|
|
332
479
|
export type CreateUserCredentialFido2Input = {
|
|
333
480
|
credentialKind: CredentialKind.Fido2;
|
|
334
481
|
credentialInfo: CredentialAssertion;
|
|
335
482
|
challengeIdentifier: Jwt;
|
|
336
483
|
credentialName: string;
|
|
337
484
|
};
|
|
485
|
+
/**
|
|
486
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
487
|
+
*/
|
|
338
488
|
export type HttpRequestInformation = {
|
|
339
489
|
method: string;
|
|
340
490
|
scheme: string;
|
|
341
491
|
authority: string;
|
|
342
492
|
path: string;
|
|
343
493
|
};
|
|
494
|
+
/**
|
|
495
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
496
|
+
*/
|
|
344
497
|
export type LegacyAuthAttestation = {
|
|
345
498
|
token: Jwt;
|
|
346
499
|
decodedToken: DecodedJwt;
|
|
347
500
|
authIdentity: AuthIdentity;
|
|
348
501
|
};
|
|
502
|
+
/**
|
|
503
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
504
|
+
*/
|
|
349
505
|
export type OrgEmployeeIdentity = {
|
|
350
506
|
kind: AuthIdentityKind.OrgEmployeeIdentity;
|
|
351
507
|
orgId: EntityId;
|
|
@@ -354,6 +510,9 @@ export type OrgEmployeeIdentity = {
|
|
|
354
510
|
scope: string;
|
|
355
511
|
permissions: string[];
|
|
356
512
|
};
|
|
513
|
+
/**
|
|
514
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
515
|
+
*/
|
|
357
516
|
export type OrgApiKeyIdentity = {
|
|
358
517
|
kind: AuthIdentityKind.OrgApiKeyIdentity;
|
|
359
518
|
orgId: EntityId;
|
|
@@ -361,6 +520,9 @@ export type OrgApiKeyIdentity = {
|
|
|
361
520
|
scope: string;
|
|
362
521
|
permissions: string[];
|
|
363
522
|
};
|
|
523
|
+
/**
|
|
524
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
525
|
+
*/
|
|
364
526
|
export type DfnsStaffIdentity = {
|
|
365
527
|
kind: AuthIdentityKind.DfnsStaffIdentity;
|
|
366
528
|
orgId: EntityId;
|
|
@@ -369,27 +531,45 @@ export type DfnsStaffIdentity = {
|
|
|
369
531
|
scope: string;
|
|
370
532
|
permissions: string[];
|
|
371
533
|
};
|
|
534
|
+
/**
|
|
535
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
536
|
+
*/
|
|
372
537
|
export type DfnsServiceIdentity = {
|
|
373
538
|
kind: AuthIdentityKind.DfnsService;
|
|
374
539
|
serviceName: string;
|
|
375
540
|
};
|
|
541
|
+
/**
|
|
542
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
543
|
+
*/
|
|
376
544
|
export type AuthV2SignedAuthAttestation = {
|
|
377
545
|
authBlock: AuthBlock;
|
|
378
546
|
};
|
|
547
|
+
/**
|
|
548
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
549
|
+
*/
|
|
379
550
|
export type JwtHeader = {
|
|
380
551
|
alg?: string;
|
|
381
552
|
b64?: boolean;
|
|
382
553
|
kid?: string;
|
|
383
554
|
typ?: string;
|
|
384
555
|
};
|
|
556
|
+
/**
|
|
557
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
558
|
+
*/
|
|
385
559
|
export type DecodedJwt = {
|
|
386
560
|
payload: JwtPayload;
|
|
387
561
|
header: JwtHeader;
|
|
388
562
|
};
|
|
563
|
+
/**
|
|
564
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
565
|
+
*/
|
|
389
566
|
export type AuthBlock = {
|
|
390
567
|
request: Jwt;
|
|
391
568
|
auth: Jwt;
|
|
392
569
|
};
|
|
570
|
+
/**
|
|
571
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
572
|
+
*/
|
|
393
573
|
export type CreateUserCredentialRecoveryKeyInput = {
|
|
394
574
|
encryptedPrivateKey?: string;
|
|
395
575
|
credentialInfo: CredentialAssertion;
|
|
@@ -397,20 +577,32 @@ export type CreateUserCredentialRecoveryKeyInput = {
|
|
|
397
577
|
challengeIdentifier: Jwt;
|
|
398
578
|
credentialName: string;
|
|
399
579
|
};
|
|
580
|
+
/**
|
|
581
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
582
|
+
*/
|
|
400
583
|
export type PermissionAssignmentInfo = {
|
|
401
584
|
permissionName: string;
|
|
402
585
|
permissionId: EntityId;
|
|
403
586
|
assignmentId: EntityId;
|
|
404
587
|
operations?: string[];
|
|
405
588
|
};
|
|
589
|
+
/**
|
|
590
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
591
|
+
*/
|
|
406
592
|
export type AllowRecoveryCredential = {
|
|
407
593
|
id: string;
|
|
408
594
|
encryptedRecoveryKey: string;
|
|
409
595
|
};
|
|
596
|
+
/**
|
|
597
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
598
|
+
*/
|
|
410
599
|
export type RecoverUserInput = {
|
|
411
600
|
kind: CredentialKind.RecoveryKey;
|
|
412
601
|
credentialAssertion: KeyCredentialAssertion;
|
|
413
602
|
};
|
|
603
|
+
/**
|
|
604
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
605
|
+
*/
|
|
414
606
|
export type UserRecoveryCredentials = {
|
|
415
607
|
firstFactorCredential: RegistrationFirstFactor;
|
|
416
608
|
secondFactorCredential?: RegistrationSecondFactor;
|
|
@@ -418,6 +610,9 @@ export type UserRecoveryCredentials = {
|
|
|
418
610
|
};
|
|
419
611
|
export type Jwt = string;
|
|
420
612
|
export type JwtPayload = Record<string, unknown>;
|
|
613
|
+
/**
|
|
614
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
615
|
+
*/
|
|
421
616
|
export type CreateUserActionSignatureChallengeInput = {
|
|
422
617
|
/**
|
|
423
618
|
* Human readable explanation of the activity, so that person can understand what is being signed.
|
|
@@ -427,58 +622,97 @@ export type CreateUserActionSignatureChallengeInput = {
|
|
|
427
622
|
userActionHttpPath: string;
|
|
428
623
|
userActionServerKind?: ServerKind;
|
|
429
624
|
};
|
|
625
|
+
/**
|
|
626
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
627
|
+
*/
|
|
430
628
|
export type CreateDelegatedUserLoginInput = {
|
|
431
629
|
username: string;
|
|
432
630
|
};
|
|
631
|
+
/**
|
|
632
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
633
|
+
*/
|
|
433
634
|
export type CreateUserInput = {
|
|
434
635
|
email: string;
|
|
435
636
|
kind: UserAuthKind;
|
|
436
637
|
publicKey?: string;
|
|
437
638
|
externalId?: string;
|
|
438
639
|
};
|
|
640
|
+
/**
|
|
641
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
642
|
+
*/
|
|
439
643
|
export type CreateUserRegistrationChallengeInput = {
|
|
440
644
|
username: string;
|
|
441
645
|
registrationCode: string;
|
|
442
646
|
orgId: EntityId;
|
|
443
647
|
};
|
|
648
|
+
/**
|
|
649
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
650
|
+
*/
|
|
444
651
|
export type CreateUserRegistrationInput = {
|
|
445
652
|
firstFactorCredential: RegistrationFirstFactor;
|
|
446
653
|
secondFactorCredential?: RegistrationSecondFactor;
|
|
447
654
|
recoveryCredential?: RegistrationConfirmationRecoveryKey;
|
|
448
655
|
};
|
|
656
|
+
/**
|
|
657
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
658
|
+
*/
|
|
449
659
|
export type CreateUserLoginChallengeInput = {
|
|
450
660
|
username: string;
|
|
451
661
|
orgId: EntityId;
|
|
452
662
|
};
|
|
663
|
+
/**
|
|
664
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
665
|
+
*/
|
|
453
666
|
export type CreateUserLoginInput = {
|
|
454
667
|
challengeIdentifier: Jwt;
|
|
455
668
|
firstFactor: AuthenticateUserFirstFactor;
|
|
456
669
|
secondFactor?: AuthenticateUserSecondFactor;
|
|
457
670
|
};
|
|
671
|
+
/**
|
|
672
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
673
|
+
*/
|
|
458
674
|
export type CreateUserCredentialChallengeInput = {
|
|
459
675
|
kind: CredentialKind;
|
|
460
676
|
};
|
|
677
|
+
/**
|
|
678
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
679
|
+
*/
|
|
461
680
|
export type ActivateCredentialInput = {
|
|
462
681
|
credentialUuid: EntityId;
|
|
463
682
|
};
|
|
683
|
+
/**
|
|
684
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
685
|
+
*/
|
|
464
686
|
export type CreateSignedAuthAttestationInput = {
|
|
465
687
|
body?: string;
|
|
466
688
|
headers: Record<string, string>;
|
|
467
689
|
isBase64Encoded: boolean;
|
|
468
690
|
http: HttpRequestInformation;
|
|
469
691
|
};
|
|
692
|
+
/**
|
|
693
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
694
|
+
*/
|
|
470
695
|
export type CreateCodeLoginChallengeInput = {
|
|
471
696
|
code: string;
|
|
472
697
|
};
|
|
698
|
+
/**
|
|
699
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
700
|
+
*/
|
|
473
701
|
export type CreateUserLoginFromCodeInput = {
|
|
474
702
|
challengeIdentifier: Jwt;
|
|
475
703
|
};
|
|
704
|
+
/**
|
|
705
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
706
|
+
*/
|
|
476
707
|
export type CreateOrgOwnerInput = {
|
|
477
708
|
email: Email;
|
|
478
709
|
publicKey?: string;
|
|
479
710
|
orgId: EntityId;
|
|
480
711
|
authBlock: AuthBlock;
|
|
481
712
|
};
|
|
713
|
+
/**
|
|
714
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
715
|
+
*/
|
|
482
716
|
export type CreateAvailableOrgListInput = {
|
|
483
717
|
/**
|
|
484
718
|
* The username of the user that is logging into the system.
|
|
@@ -503,6 +737,9 @@ export type CreateAvailableOrgListInput = {
|
|
|
503
737
|
*/
|
|
504
738
|
origin: string;
|
|
505
739
|
};
|
|
740
|
+
/**
|
|
741
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
742
|
+
*/
|
|
506
743
|
export type CreateAccessTokenInput = {
|
|
507
744
|
daysValid?: IntegerPositiveStrict;
|
|
508
745
|
name: string;
|
|
@@ -510,18 +747,30 @@ export type CreateAccessTokenInput = {
|
|
|
510
747
|
publicKey: string;
|
|
511
748
|
externalId?: string;
|
|
512
749
|
};
|
|
750
|
+
/**
|
|
751
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
752
|
+
*/
|
|
513
753
|
export type UpdateAccessTokenInput = {
|
|
514
754
|
name?: string;
|
|
515
755
|
externalId?: string;
|
|
516
756
|
};
|
|
757
|
+
/**
|
|
758
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
759
|
+
*/
|
|
517
760
|
export type UpdateUserInput = {
|
|
518
761
|
externalId?: string;
|
|
519
762
|
publicKey?: string;
|
|
520
763
|
};
|
|
764
|
+
/**
|
|
765
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
766
|
+
*/
|
|
521
767
|
export type UpdateApplicationInput = {
|
|
522
768
|
externalId?: string;
|
|
523
769
|
name?: string;
|
|
524
770
|
};
|
|
771
|
+
/**
|
|
772
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
773
|
+
*/
|
|
525
774
|
export type CreateApplicationInput = {
|
|
526
775
|
name: string;
|
|
527
776
|
relyingPartyId: string;
|
|
@@ -532,28 +781,64 @@ export type CreateApplicationInput = {
|
|
|
532
781
|
publicKey?: string;
|
|
533
782
|
externalId?: string;
|
|
534
783
|
};
|
|
784
|
+
/**
|
|
785
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
786
|
+
*/
|
|
535
787
|
export type CreateUserRecoveryInput = {
|
|
536
788
|
recovery: RecoverUserInput;
|
|
537
789
|
newCredentials: UserRecoveryCredentials;
|
|
538
790
|
};
|
|
791
|
+
/**
|
|
792
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
793
|
+
*/
|
|
539
794
|
export type CreateUserRecoveryChallengeInput = {
|
|
540
795
|
username: string;
|
|
541
796
|
verificationCode: string;
|
|
542
797
|
orgId: EntityId;
|
|
543
798
|
credentialId: string;
|
|
544
799
|
};
|
|
800
|
+
/**
|
|
801
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
802
|
+
*/
|
|
545
803
|
export type CreateDelegatedUserRecoveryInput = {
|
|
546
804
|
username: string;
|
|
547
805
|
credentialId: string;
|
|
548
806
|
};
|
|
807
|
+
/**
|
|
808
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
809
|
+
*/
|
|
549
810
|
export type CreateUserCredentialInput = CreateUserCredentialTotpInput | CreateUserCredentialPasswordInput | CreateUserCredentialPublicKeyInput | CreateUserCredentialFido2Input | CreateUserCredentialRecoveryKeyInput;
|
|
811
|
+
/**
|
|
812
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
813
|
+
*/
|
|
550
814
|
export type UserCredentialChallenge = Fido2Options | PublicKeyOptions | TotpCredential | PasswordCredential;
|
|
815
|
+
/**
|
|
816
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
817
|
+
*/
|
|
551
818
|
export type SignedAuthAttestation = LegacyAuthAttestation | AuthV2SignedAuthAttestation;
|
|
819
|
+
/**
|
|
820
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
821
|
+
*/
|
|
552
822
|
export type RegistrationFirstFactor = RegistrationConfirmationFido2 | RegistrationConfirmationKey | RegistrationConfirmationPassword;
|
|
823
|
+
/**
|
|
824
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
825
|
+
*/
|
|
553
826
|
export type RegistrationSecondFactor = RegistrationConfirmationFido2 | RegistrationConfirmationKey | RegistrationConfirmationTotp;
|
|
827
|
+
/**
|
|
828
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
829
|
+
*/
|
|
554
830
|
export type AuthenticateUserFirstFactor = AuthenticateUserPasswordInput | AuthenticateUserFido2Input | AuthenticateUserKeyInput;
|
|
831
|
+
/**
|
|
832
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
833
|
+
*/
|
|
555
834
|
export type AuthenticateUserSecondFactor = AuthenticateUserFido2Input | AuthenticateUserKeyInput | AuthenticateUserTotpInput;
|
|
835
|
+
/**
|
|
836
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
837
|
+
*/
|
|
556
838
|
export type AuthIdentity = OrgEmployeeIdentity | OrgApiKeyIdentity | DfnsStaffIdentity | DfnsServiceIdentity;
|
|
839
|
+
/**
|
|
840
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
841
|
+
*/
|
|
557
842
|
export declare enum CredentialKind {
|
|
558
843
|
Fido2 = "Fido2",
|
|
559
844
|
Key = "Key",
|
|
@@ -561,6 +846,9 @@ export declare enum CredentialKind {
|
|
|
561
846
|
Totp = "Totp",
|
|
562
847
|
RecoveryKey = "RecoveryKey"
|
|
563
848
|
}
|
|
849
|
+
/**
|
|
850
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
851
|
+
*/
|
|
564
852
|
export declare enum UserKind {
|
|
565
853
|
CustomerEmployee = "CustomerEmployee",
|
|
566
854
|
DfnsStaff = "DfnsStaff",
|
|
@@ -569,21 +857,33 @@ export declare enum UserKind {
|
|
|
569
857
|
Application = "Application",
|
|
570
858
|
ServiceAccount = "ServiceAccount"
|
|
571
859
|
}
|
|
860
|
+
/**
|
|
861
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
862
|
+
*/
|
|
572
863
|
export declare enum AuthenticatorRequirementOptions {
|
|
573
864
|
required = "required",
|
|
574
865
|
preferred = "preferred",
|
|
575
866
|
discouraged = "discouraged"
|
|
576
867
|
}
|
|
868
|
+
/**
|
|
869
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
870
|
+
*/
|
|
577
871
|
export declare enum AuthenticatorAttestationOptions {
|
|
578
872
|
none = "none",
|
|
579
873
|
indirect = "indirect",
|
|
580
874
|
direct = "direct",
|
|
581
875
|
enterprise = "enterprise"
|
|
582
876
|
}
|
|
877
|
+
/**
|
|
878
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
879
|
+
*/
|
|
583
880
|
export declare enum ApplicationKind {
|
|
584
881
|
ServerSideApplication = "ServerSideApplication",
|
|
585
882
|
ClientSideApplication = "ClientSideApplication"
|
|
586
883
|
}
|
|
884
|
+
/**
|
|
885
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
886
|
+
*/
|
|
587
887
|
export declare enum FidoCredentialsTransportKind {
|
|
588
888
|
usb = "usb",
|
|
589
889
|
nfc = "nfc",
|
|
@@ -591,25 +891,40 @@ export declare enum FidoCredentialsTransportKind {
|
|
|
591
891
|
internal = "internal",
|
|
592
892
|
hybrid = "hybrid"
|
|
593
893
|
}
|
|
894
|
+
/**
|
|
895
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
896
|
+
*/
|
|
594
897
|
export declare enum CredentialFactor {
|
|
595
898
|
first = "first",
|
|
596
899
|
second = "second",
|
|
597
900
|
either = "either"
|
|
598
901
|
}
|
|
902
|
+
/**
|
|
903
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
904
|
+
*/
|
|
599
905
|
export declare enum ServerKind {
|
|
600
906
|
Api = "Api",
|
|
601
907
|
Staff = "Staff"
|
|
602
908
|
}
|
|
909
|
+
/**
|
|
910
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
911
|
+
*/
|
|
603
912
|
export declare enum AccessTokenKind {
|
|
604
913
|
ServiceAccount = "ServiceAccount",
|
|
605
914
|
Pat = "Pat",
|
|
606
915
|
Application = "Application"
|
|
607
916
|
}
|
|
917
|
+
/**
|
|
918
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
919
|
+
*/
|
|
608
920
|
export declare enum UserAuthKind {
|
|
609
921
|
EndUser = "EndUser",
|
|
610
922
|
CustomerEmployee = "CustomerEmployee",
|
|
611
923
|
DfnsStaff = "DfnsStaff"
|
|
612
924
|
}
|
|
925
|
+
/**
|
|
926
|
+
* @deprecated import equivalent type from '@dfns/sdk/types/auth' instead
|
|
927
|
+
*/
|
|
613
928
|
export declare enum AuthIdentityKind {
|
|
614
929
|
DfnsStaffIdentity = "DfnsStaffIdentity",
|
|
615
930
|
OrgEmployeeIdentity = "OrgEmployeeIdentity",
|