@faable/auth-sdk 1.3.22 → 1.3.23
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/dist/api/types.d.ts +399 -8
- package/package.json +1 -1
- package/spec/openapi.json +1302 -1657
package/dist/api/types.d.ts
CHANGED
|
@@ -419,6 +419,78 @@ export interface paths {
|
|
|
419
419
|
patch?: never;
|
|
420
420
|
trace?: never;
|
|
421
421
|
};
|
|
422
|
+
"/credentials": {
|
|
423
|
+
parameters: {
|
|
424
|
+
query?: never;
|
|
425
|
+
header?: never;
|
|
426
|
+
path?: never;
|
|
427
|
+
cookie?: never;
|
|
428
|
+
};
|
|
429
|
+
/**
|
|
430
|
+
* List Credentialss
|
|
431
|
+
* @description List Credentialss
|
|
432
|
+
*/
|
|
433
|
+
get: operations["credentials/list"];
|
|
434
|
+
put?: never;
|
|
435
|
+
/**
|
|
436
|
+
* Create Credentials
|
|
437
|
+
* @description Create Credentials
|
|
438
|
+
*/
|
|
439
|
+
post: operations["credentials/create"];
|
|
440
|
+
delete?: never;
|
|
441
|
+
options?: never;
|
|
442
|
+
head?: never;
|
|
443
|
+
patch?: never;
|
|
444
|
+
trace?: never;
|
|
445
|
+
};
|
|
446
|
+
"/credentials/{credentials_id}": {
|
|
447
|
+
parameters: {
|
|
448
|
+
query?: never;
|
|
449
|
+
header?: never;
|
|
450
|
+
path?: never;
|
|
451
|
+
cookie?: never;
|
|
452
|
+
};
|
|
453
|
+
/**
|
|
454
|
+
* Get Credentials
|
|
455
|
+
* @description Get Credentials
|
|
456
|
+
*/
|
|
457
|
+
get: operations["credentials/get"];
|
|
458
|
+
put?: never;
|
|
459
|
+
/**
|
|
460
|
+
* Update Credentials
|
|
461
|
+
* @description Update Credentials
|
|
462
|
+
*/
|
|
463
|
+
post: operations["credentials/update"];
|
|
464
|
+
/**
|
|
465
|
+
* Delete Credentials
|
|
466
|
+
* @description Delete Credentials
|
|
467
|
+
*/
|
|
468
|
+
delete: operations["credentials/delete"];
|
|
469
|
+
options?: never;
|
|
470
|
+
head?: never;
|
|
471
|
+
patch?: never;
|
|
472
|
+
trace?: never;
|
|
473
|
+
};
|
|
474
|
+
"/credentials/{credentials_id}/set-password": {
|
|
475
|
+
parameters: {
|
|
476
|
+
query?: never;
|
|
477
|
+
header?: never;
|
|
478
|
+
path?: never;
|
|
479
|
+
cookie?: never;
|
|
480
|
+
};
|
|
481
|
+
get?: never;
|
|
482
|
+
put?: never;
|
|
483
|
+
/**
|
|
484
|
+
* Set a credential's password
|
|
485
|
+
* @description Sets or rotates the password for a database credential. The previous password is invalidated immediately. Records a `credential.password_changed` audit entry (initiated_by=admin) for traceability. The password is never returned.
|
|
486
|
+
*/
|
|
487
|
+
post: operations["credentials/setPassword"];
|
|
488
|
+
delete?: never;
|
|
489
|
+
options?: never;
|
|
490
|
+
head?: never;
|
|
491
|
+
patch?: never;
|
|
492
|
+
trace?: never;
|
|
493
|
+
};
|
|
422
494
|
"/role": {
|
|
423
495
|
parameters: {
|
|
424
496
|
query?: never;
|
|
@@ -1934,8 +2006,6 @@ export interface components {
|
|
|
1934
2006
|
locale?: string;
|
|
1935
2007
|
/** @description A URI pointing to the user's picture. */
|
|
1936
2008
|
picture?: string;
|
|
1937
|
-
/** @description Initial password for this user. Only used (and required) when the user is being provisioned against a `database` connection; ignored for federated/social connections. */
|
|
1938
|
-
password?: string;
|
|
1939
2009
|
/** @description User Metadata */
|
|
1940
2010
|
user_metadata?: {
|
|
1941
2011
|
[key: string]: unknown;
|
|
@@ -1965,8 +2035,6 @@ export interface components {
|
|
|
1965
2035
|
email?: string;
|
|
1966
2036
|
/** @description Flip the email verification flag. Setting `true` marks the email as verified by the admin (`email_verified_method=manual`). Setting `false` clears the verification metadata. */
|
|
1967
2037
|
email_verified?: boolean;
|
|
1968
|
-
/** @description New password for this user */
|
|
1969
|
-
password?: string;
|
|
1970
2038
|
/** @description Contact phone number. Changing it to a new value automatically resets `phone_verified` to false (and clears `phone_verified_method` / `phone_verified_at`) unless the same patch sets `phone_verified` explicitly. */
|
|
1971
2039
|
phone?: string;
|
|
1972
2040
|
/** @description Flip the phone verification flag. Setting `true` marks the phone as verified by the admin (`phone_verified_method=manual`). */
|
|
@@ -2040,6 +2108,47 @@ export interface components {
|
|
|
2040
2108
|
refresh_token?: string;
|
|
2041
2109
|
profile_data: unknown;
|
|
2042
2110
|
};
|
|
2111
|
+
/** @description Credential */
|
|
2112
|
+
Credential: {
|
|
2113
|
+
/** @description Credential ID */
|
|
2114
|
+
id: string;
|
|
2115
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
2116
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
2117
|
+
/** @description Email login identifier (unique within the connection). */
|
|
2118
|
+
email?: string;
|
|
2119
|
+
/** @description Username login identifier (unique within the connection). */
|
|
2120
|
+
username?: string;
|
|
2121
|
+
/** @description Object is related with this account */
|
|
2122
|
+
account: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* @description CredentialMetadata
|
|
2125
|
+
* @default {}
|
|
2126
|
+
*/
|
|
2127
|
+
metadata: {
|
|
2128
|
+
[key: string]: unknown;
|
|
2129
|
+
};
|
|
2130
|
+
/** @description Credential creation date */
|
|
2131
|
+
createdAt: string;
|
|
2132
|
+
/** @description Credential updated date */
|
|
2133
|
+
updatedAt?: string;
|
|
2134
|
+
};
|
|
2135
|
+
/**
|
|
2136
|
+
* @description CredentialMetadata
|
|
2137
|
+
* @default {}
|
|
2138
|
+
*/
|
|
2139
|
+
CredentialMetadata: {
|
|
2140
|
+
[key: string]: unknown;
|
|
2141
|
+
};
|
|
2142
|
+
CredentialsCreate: {
|
|
2143
|
+
user: string;
|
|
2144
|
+
connection: string;
|
|
2145
|
+
email?: string;
|
|
2146
|
+
username?: string;
|
|
2147
|
+
};
|
|
2148
|
+
CredentialsUpdate: {
|
|
2149
|
+
email?: string;
|
|
2150
|
+
username?: string;
|
|
2151
|
+
};
|
|
2043
2152
|
/** @description Role */
|
|
2044
2153
|
Role: {
|
|
2045
2154
|
/** @description Role ID */
|
|
@@ -2968,6 +3077,8 @@ export interface components {
|
|
|
2968
3077
|
/** @description An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks. */
|
|
2969
3078
|
state?: string;
|
|
2970
3079
|
response_type?: string;
|
|
3080
|
+
/** @description Same-origin path to return the user to after authentication, instead of the OAuth client redirect. Used by first-party interactive flows (e.g. device-code confirm). Non same-origin values are ignored. */
|
|
3081
|
+
redirect_to?: string;
|
|
2971
3082
|
client_id: string;
|
|
2972
3083
|
/** @description Deprecated. Use connection_id */
|
|
2973
3084
|
connection?: string;
|
|
@@ -4262,8 +4373,6 @@ export interface operations {
|
|
|
4262
4373
|
locale?: string;
|
|
4263
4374
|
/** @description A URI pointing to the user's picture. */
|
|
4264
4375
|
picture?: string;
|
|
4265
|
-
/** @description Initial password for this user. Only used (and required) when the user is being provisioned against a `database` connection; ignored for federated/social connections. */
|
|
4266
|
-
password?: string;
|
|
4267
4376
|
/** @description User Metadata */
|
|
4268
4377
|
user_metadata?: {
|
|
4269
4378
|
[key: string]: unknown;
|
|
@@ -4526,8 +4635,6 @@ export interface operations {
|
|
|
4526
4635
|
email?: string;
|
|
4527
4636
|
/** @description Flip the email verification flag. Setting `true` marks the email as verified by the admin (`email_verified_method=manual`). Setting `false` clears the verification metadata. */
|
|
4528
4637
|
email_verified?: boolean;
|
|
4529
|
-
/** @description New password for this user */
|
|
4530
|
-
password?: string;
|
|
4531
4638
|
/** @description Contact phone number. Changing it to a new value automatically resets `phone_verified` to false (and clears `phone_verified_method` / `phone_verified_at`) unless the same patch sets `phone_verified` explicitly. */
|
|
4532
4639
|
phone?: string;
|
|
4533
4640
|
/** @description Flip the phone verification flag. Setting `true` marks the phone as verified by the admin (`phone_verified_method=manual`). */
|
|
@@ -5109,6 +5216,286 @@ export interface operations {
|
|
|
5109
5216
|
};
|
|
5110
5217
|
};
|
|
5111
5218
|
};
|
|
5219
|
+
"credentials/list": {
|
|
5220
|
+
parameters: {
|
|
5221
|
+
query?: {
|
|
5222
|
+
/** @description Number of items per page (max 200) */
|
|
5223
|
+
pageSize?: number;
|
|
5224
|
+
/** @description Cursor for next page */
|
|
5225
|
+
cursor?: string;
|
|
5226
|
+
/** @description Cursor returned by the previous page */
|
|
5227
|
+
next?: string;
|
|
5228
|
+
/** @description Filter using a FaableQL query */
|
|
5229
|
+
query?: string;
|
|
5230
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `?expand=user`). */
|
|
5231
|
+
expand?: ("user" | "connection")[];
|
|
5232
|
+
/** @description Full-text search across: `email`, `username`. */
|
|
5233
|
+
q?: string;
|
|
5234
|
+
};
|
|
5235
|
+
header?: never;
|
|
5236
|
+
path?: never;
|
|
5237
|
+
cookie?: never;
|
|
5238
|
+
};
|
|
5239
|
+
requestBody?: never;
|
|
5240
|
+
responses: {
|
|
5241
|
+
/** @description Default Response */
|
|
5242
|
+
200: {
|
|
5243
|
+
headers: {
|
|
5244
|
+
[name: string]: unknown;
|
|
5245
|
+
};
|
|
5246
|
+
content: {
|
|
5247
|
+
"application/json": {
|
|
5248
|
+
next: string | null;
|
|
5249
|
+
results: components["schemas"]["Credential"][];
|
|
5250
|
+
};
|
|
5251
|
+
};
|
|
5252
|
+
};
|
|
5253
|
+
};
|
|
5254
|
+
};
|
|
5255
|
+
"credentials/create": {
|
|
5256
|
+
parameters: {
|
|
5257
|
+
query?: never;
|
|
5258
|
+
header?: never;
|
|
5259
|
+
path?: never;
|
|
5260
|
+
cookie?: never;
|
|
5261
|
+
};
|
|
5262
|
+
requestBody: {
|
|
5263
|
+
content: {
|
|
5264
|
+
"application/json": {
|
|
5265
|
+
user: string;
|
|
5266
|
+
connection: string;
|
|
5267
|
+
email?: string;
|
|
5268
|
+
username?: string;
|
|
5269
|
+
};
|
|
5270
|
+
};
|
|
5271
|
+
};
|
|
5272
|
+
responses: {
|
|
5273
|
+
/** @description Credential */
|
|
5274
|
+
200: {
|
|
5275
|
+
headers: {
|
|
5276
|
+
[name: string]: unknown;
|
|
5277
|
+
};
|
|
5278
|
+
content: {
|
|
5279
|
+
"application/json": {
|
|
5280
|
+
/** @description Credential ID */
|
|
5281
|
+
id: string;
|
|
5282
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
5283
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
5284
|
+
/** @description Email login identifier (unique within the connection). */
|
|
5285
|
+
email?: string;
|
|
5286
|
+
/** @description Username login identifier (unique within the connection). */
|
|
5287
|
+
username?: string;
|
|
5288
|
+
/** @description Object is related with this account */
|
|
5289
|
+
account: string;
|
|
5290
|
+
/**
|
|
5291
|
+
* @description CredentialMetadata
|
|
5292
|
+
* @default {}
|
|
5293
|
+
*/
|
|
5294
|
+
metadata: {
|
|
5295
|
+
[key: string]: unknown;
|
|
5296
|
+
};
|
|
5297
|
+
/** @description Credential creation date */
|
|
5298
|
+
createdAt: string;
|
|
5299
|
+
/** @description Credential updated date */
|
|
5300
|
+
updatedAt?: string;
|
|
5301
|
+
};
|
|
5302
|
+
};
|
|
5303
|
+
};
|
|
5304
|
+
};
|
|
5305
|
+
};
|
|
5306
|
+
"credentials/get": {
|
|
5307
|
+
parameters: {
|
|
5308
|
+
query?: {
|
|
5309
|
+
/** @description Expand id-only fields in the response. Pass one path per entry (e.g. `?expand=user`). */
|
|
5310
|
+
expand?: ("user" | "connection")[];
|
|
5311
|
+
};
|
|
5312
|
+
header?: never;
|
|
5313
|
+
path: {
|
|
5314
|
+
credentials_id: string;
|
|
5315
|
+
};
|
|
5316
|
+
cookie?: never;
|
|
5317
|
+
};
|
|
5318
|
+
requestBody?: never;
|
|
5319
|
+
responses: {
|
|
5320
|
+
/** @description Credential */
|
|
5321
|
+
200: {
|
|
5322
|
+
headers: {
|
|
5323
|
+
[name: string]: unknown;
|
|
5324
|
+
};
|
|
5325
|
+
content: {
|
|
5326
|
+
"application/json": {
|
|
5327
|
+
/** @description Credential ID */
|
|
5328
|
+
id: string;
|
|
5329
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
5330
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
5331
|
+
/** @description Email login identifier (unique within the connection). */
|
|
5332
|
+
email?: string;
|
|
5333
|
+
/** @description Username login identifier (unique within the connection). */
|
|
5334
|
+
username?: string;
|
|
5335
|
+
/** @description Object is related with this account */
|
|
5336
|
+
account: string;
|
|
5337
|
+
/**
|
|
5338
|
+
* @description CredentialMetadata
|
|
5339
|
+
* @default {}
|
|
5340
|
+
*/
|
|
5341
|
+
metadata: {
|
|
5342
|
+
[key: string]: unknown;
|
|
5343
|
+
};
|
|
5344
|
+
/** @description Credential creation date */
|
|
5345
|
+
createdAt: string;
|
|
5346
|
+
/** @description Credential updated date */
|
|
5347
|
+
updatedAt?: string;
|
|
5348
|
+
};
|
|
5349
|
+
};
|
|
5350
|
+
};
|
|
5351
|
+
};
|
|
5352
|
+
};
|
|
5353
|
+
"credentials/update": {
|
|
5354
|
+
parameters: {
|
|
5355
|
+
query?: never;
|
|
5356
|
+
header?: never;
|
|
5357
|
+
path: {
|
|
5358
|
+
credentials_id: string;
|
|
5359
|
+
};
|
|
5360
|
+
cookie?: never;
|
|
5361
|
+
};
|
|
5362
|
+
requestBody: {
|
|
5363
|
+
content: {
|
|
5364
|
+
"application/json": {
|
|
5365
|
+
email?: string;
|
|
5366
|
+
username?: string;
|
|
5367
|
+
};
|
|
5368
|
+
};
|
|
5369
|
+
};
|
|
5370
|
+
responses: {
|
|
5371
|
+
/** @description Credential */
|
|
5372
|
+
200: {
|
|
5373
|
+
headers: {
|
|
5374
|
+
[name: string]: unknown;
|
|
5375
|
+
};
|
|
5376
|
+
content: {
|
|
5377
|
+
"application/json": {
|
|
5378
|
+
/** @description Credential ID */
|
|
5379
|
+
id: string;
|
|
5380
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
5381
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
5382
|
+
/** @description Email login identifier (unique within the connection). */
|
|
5383
|
+
email?: string;
|
|
5384
|
+
/** @description Username login identifier (unique within the connection). */
|
|
5385
|
+
username?: string;
|
|
5386
|
+
/** @description Object is related with this account */
|
|
5387
|
+
account: string;
|
|
5388
|
+
/**
|
|
5389
|
+
* @description CredentialMetadata
|
|
5390
|
+
* @default {}
|
|
5391
|
+
*/
|
|
5392
|
+
metadata: {
|
|
5393
|
+
[key: string]: unknown;
|
|
5394
|
+
};
|
|
5395
|
+
/** @description Credential creation date */
|
|
5396
|
+
createdAt: string;
|
|
5397
|
+
/** @description Credential updated date */
|
|
5398
|
+
updatedAt?: string;
|
|
5399
|
+
};
|
|
5400
|
+
};
|
|
5401
|
+
};
|
|
5402
|
+
};
|
|
5403
|
+
};
|
|
5404
|
+
"credentials/delete": {
|
|
5405
|
+
parameters: {
|
|
5406
|
+
query?: never;
|
|
5407
|
+
header?: never;
|
|
5408
|
+
path: {
|
|
5409
|
+
credentials_id: string;
|
|
5410
|
+
};
|
|
5411
|
+
cookie?: never;
|
|
5412
|
+
};
|
|
5413
|
+
requestBody?: never;
|
|
5414
|
+
responses: {
|
|
5415
|
+
/** @description Credential */
|
|
5416
|
+
200: {
|
|
5417
|
+
headers: {
|
|
5418
|
+
[name: string]: unknown;
|
|
5419
|
+
};
|
|
5420
|
+
content: {
|
|
5421
|
+
"application/json": {
|
|
5422
|
+
/** @description Credential ID */
|
|
5423
|
+
id: string;
|
|
5424
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
5425
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
5426
|
+
/** @description Email login identifier (unique within the connection). */
|
|
5427
|
+
email?: string;
|
|
5428
|
+
/** @description Username login identifier (unique within the connection). */
|
|
5429
|
+
username?: string;
|
|
5430
|
+
/** @description Object is related with this account */
|
|
5431
|
+
account: string;
|
|
5432
|
+
/**
|
|
5433
|
+
* @description CredentialMetadata
|
|
5434
|
+
* @default {}
|
|
5435
|
+
*/
|
|
5436
|
+
metadata: {
|
|
5437
|
+
[key: string]: unknown;
|
|
5438
|
+
};
|
|
5439
|
+
/** @description Credential creation date */
|
|
5440
|
+
createdAt: string;
|
|
5441
|
+
/** @description Credential updated date */
|
|
5442
|
+
updatedAt?: string;
|
|
5443
|
+
};
|
|
5444
|
+
};
|
|
5445
|
+
};
|
|
5446
|
+
};
|
|
5447
|
+
};
|
|
5448
|
+
"credentials/setPassword": {
|
|
5449
|
+
parameters: {
|
|
5450
|
+
query?: never;
|
|
5451
|
+
header?: never;
|
|
5452
|
+
path: {
|
|
5453
|
+
credentials_id: string;
|
|
5454
|
+
};
|
|
5455
|
+
cookie?: never;
|
|
5456
|
+
};
|
|
5457
|
+
requestBody: {
|
|
5458
|
+
content: {
|
|
5459
|
+
"application/json": {
|
|
5460
|
+
/** @description New plaintext password (hashed on write). */
|
|
5461
|
+
password: string;
|
|
5462
|
+
};
|
|
5463
|
+
};
|
|
5464
|
+
};
|
|
5465
|
+
responses: {
|
|
5466
|
+
/** @description Credential */
|
|
5467
|
+
200: {
|
|
5468
|
+
headers: {
|
|
5469
|
+
[name: string]: unknown;
|
|
5470
|
+
};
|
|
5471
|
+
content: {
|
|
5472
|
+
"application/json": {
|
|
5473
|
+
/** @description Credential ID */
|
|
5474
|
+
id: string;
|
|
5475
|
+
connection: components["schemas"]["Connection"] | string | unknown;
|
|
5476
|
+
user: components["schemas"]["User"] | string | unknown;
|
|
5477
|
+
/** @description Email login identifier (unique within the connection). */
|
|
5478
|
+
email?: string;
|
|
5479
|
+
/** @description Username login identifier (unique within the connection). */
|
|
5480
|
+
username?: string;
|
|
5481
|
+
/** @description Object is related with this account */
|
|
5482
|
+
account: string;
|
|
5483
|
+
/**
|
|
5484
|
+
* @description CredentialMetadata
|
|
5485
|
+
* @default {}
|
|
5486
|
+
*/
|
|
5487
|
+
metadata: {
|
|
5488
|
+
[key: string]: unknown;
|
|
5489
|
+
};
|
|
5490
|
+
/** @description Credential creation date */
|
|
5491
|
+
createdAt: string;
|
|
5492
|
+
/** @description Credential updated date */
|
|
5493
|
+
updatedAt?: string;
|
|
5494
|
+
};
|
|
5495
|
+
};
|
|
5496
|
+
};
|
|
5497
|
+
};
|
|
5498
|
+
};
|
|
5112
5499
|
"role/list": {
|
|
5113
5500
|
parameters: {
|
|
5114
5501
|
query?: {
|
|
@@ -7996,6 +8383,8 @@ export interface operations {
|
|
|
7996
8383
|
code_challenge_method?: string;
|
|
7997
8384
|
/** @description Challenge for PKCE authorization code flow */
|
|
7998
8385
|
code_challenge?: string;
|
|
8386
|
+
/** @description Same-origin path to return the user to after authentication, instead of the OAuth client redirect. Used by first-party interactive flows (e.g. device-code confirm). Non same-origin values are ignored. */
|
|
8387
|
+
redirect_to?: string;
|
|
7999
8388
|
client_id: string;
|
|
8000
8389
|
/** @description Deprecated. Use connection_id */
|
|
8001
8390
|
connection?: string;
|
|
@@ -8540,6 +8929,8 @@ export interface operations {
|
|
|
8540
8929
|
/** @description An opaque value the applications adds to the initial request that the authorization server includes when redirecting the back to the application. This value must be used by the application to prevent CSRF attacks. */
|
|
8541
8930
|
state?: string;
|
|
8542
8931
|
response_type?: string;
|
|
8932
|
+
/** @description Same-origin path to return the user to after authentication, instead of the OAuth client redirect. Used by first-party interactive flows (e.g. device-code confirm). Non same-origin values are ignored. */
|
|
8933
|
+
redirect_to?: string;
|
|
8543
8934
|
client_id: string;
|
|
8544
8935
|
/** @description Deprecated. Use connection_id */
|
|
8545
8936
|
connection?: string;
|