@faable/auth-sdk 2.4.15 → 2.4.16

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 (5) hide show
  1. package/dist/FaableAuthApi.d.ts +18 -0
  2. package/dist/api/generated-client.d.ts +21 -0
  3. package/dist/api/types.d.ts +62 -0
  4. package/package.json +1 -1
  5. package/spec/openapi.json +109 -1
package/dist/FaableAuthApi.d.ts CHANGED
@@ -88,6 +88,9 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
88
88
  logins_count: number;
89
89
  last_ip?: string | null | undefined;
90
90
  last_login?: string | null | undefined;
91
+ suspended: boolean;
92
+ suspended_at?: string | null | undefined;
93
+ suspended_reason?: string | null | undefined;
91
94
  user_metadata: {
92
95
  [key: string]: unknown;
93
96
  };
@@ -138,6 +141,9 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
138
141
  logins_count: number;
139
142
  last_ip?: string | null | undefined;
140
143
  last_login?: string | null | undefined;
144
+ suspended: boolean;
145
+ suspended_at?: string | null | undefined;
146
+ suspended_reason?: string | null | undefined;
141
147
  user_metadata: {
142
148
  [key: string]: unknown;
143
149
  };
@@ -191,6 +197,9 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
191
197
  logins_count: number;
192
198
  last_ip?: string | null | undefined;
193
199
  last_login?: string | null | undefined;
200
+ suspended: boolean;
201
+ suspended_at?: string | null | undefined;
202
+ suspended_reason?: string | null | undefined;
194
203
  user_metadata: {
195
204
  [key: string]: unknown;
196
205
  };
@@ -243,6 +252,9 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
243
252
  logins_count: number;
244
253
  last_ip?: string | null | undefined;
245
254
  last_login?: string | null | undefined;
255
+ suspended: boolean;
256
+ suspended_at?: string | null | undefined;
257
+ suspended_reason?: string | null | undefined;
246
258
  user_metadata: {
247
259
  [key: string]: unknown;
248
260
  };
@@ -294,6 +306,9 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
294
306
  logins_count: number;
295
307
  last_ip?: string | null | undefined;
296
308
  last_login?: string | null | undefined;
309
+ suspended: boolean;
310
+ suspended_at?: string | null | undefined;
311
+ suspended_reason?: string | null | undefined;
297
312
  user_metadata: {
298
313
  [key: string]: unknown;
299
314
  };
@@ -345,6 +360,9 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
345
360
  logins_count: number;
346
361
  last_ip?: string | null | undefined;
347
362
  last_login?: string | null | undefined;
363
+ suspended: boolean;
364
+ suspended_at?: string | null | undefined;
365
+ suspended_reason?: string | null | undefined;
348
366
  user_metadata: {
349
367
  [key: string]: unknown;
350
368
  };
package/dist/api/generated-client.d.ts CHANGED
@@ -2551,6 +2551,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2551
2551
  logins_count: number;
2552
2552
  last_ip?: string | null | undefined;
2553
2553
  last_login?: string | null | undefined;
2554
+ suspended: boolean;
2555
+ suspended_at?: string | null | undefined;
2556
+ suspended_reason?: string | null | undefined;
2554
2557
  user_metadata: {
2555
2558
  [key: string]: unknown;
2556
2559
  };
@@ -2606,6 +2609,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2606
2609
  logins_count: number;
2607
2610
  last_ip?: string | null | undefined;
2608
2611
  last_login?: string | null | undefined;
2612
+ suspended: boolean;
2613
+ suspended_at?: string | null | undefined;
2614
+ suspended_reason?: string | null | undefined;
2609
2615
  user_metadata: {
2610
2616
  [key: string]: unknown;
2611
2617
  };
@@ -2661,6 +2667,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2661
2667
  logins_count: number;
2662
2668
  last_ip?: string | null | undefined;
2663
2669
  last_login?: string | null | undefined;
2670
+ suspended: boolean;
2671
+ suspended_at?: string | null | undefined;
2672
+ suspended_reason?: string | null | undefined;
2664
2673
  user_metadata: {
2665
2674
  [key: string]: unknown;
2666
2675
  };
@@ -2717,6 +2726,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2717
2726
  logins_count: number;
2718
2727
  last_ip?: string | null | undefined;
2719
2728
  last_login?: string | null | undefined;
2729
+ suspended: boolean;
2730
+ suspended_at?: string | null | undefined;
2731
+ suspended_reason?: string | null | undefined;
2720
2732
  user_metadata: {
2721
2733
  [key: string]: unknown;
2722
2734
  };
@@ -2767,6 +2779,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2767
2779
  logins_count: number;
2768
2780
  last_ip?: string | null | undefined;
2769
2781
  last_login?: string | null | undefined;
2782
+ suspended: boolean;
2783
+ suspended_at?: string | null | undefined;
2784
+ suspended_reason?: string | null | undefined;
2770
2785
  user_metadata: {
2771
2786
  [key: string]: unknown;
2772
2787
  };
@@ -2820,6 +2835,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2820
2835
  logins_count: number;
2821
2836
  last_ip?: string | null | undefined;
2822
2837
  last_login?: string | null | undefined;
2838
+ suspended: boolean;
2839
+ suspended_at?: string | null | undefined;
2840
+ suspended_reason?: string | null | undefined;
2823
2841
  user_metadata: {
2824
2842
  [key: string]: unknown;
2825
2843
  };
@@ -2876,6 +2894,9 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
2876
2894
  logins_count: number;
2877
2895
  last_ip?: string | null | undefined;
2878
2896
  last_login?: string | null | undefined;
2897
+ suspended: boolean;
2898
+ suspended_at?: string | null | undefined;
2899
+ suspended_reason?: string | null | undefined;
2879
2900
  user_metadata: {
2880
2901
  [key: string]: unknown;
2881
2902
  };
package/dist/api/types.d.ts CHANGED
@@ -2014,6 +2014,15 @@ export interface components {
2014
2014
  last_ip?: string | null;
2015
2015
  /** @description Last date and time this user logged in (ISO_8601 format) */
2016
2016
  last_login?: string | null;
2017
+ /**
2018
+ * @description true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.
2019
+ * @default false
2020
+ */
2021
+ suspended: boolean;
2022
+ /** @description ISO 8601 timestamp of when `suspended` was last flipped to true. */
2023
+ suspended_at?: string | null;
2024
+ /** @description Free-form reason recorded when the user was suspended (e.g. "abuse: RCE payload"). */
2025
+ suspended_reason?: string | null;
2017
2026
  /**
2018
2027
  * @description User Metadata
2019
2028
  * @default {}
@@ -2126,6 +2135,10 @@ export interface components {
2126
2135
  phone?: string;
2127
2136
  /** @description Flip the phone verification flag. Setting `true` marks the phone as verified by the admin (`phone_verified_method=manual`). */
2128
2137
  phone_verified?: boolean;
2138
+ /** @description Suspend (`true`) or reinstate (`false`) the user. While suspended, every login flow, token grant, session use and management-API call is rejected. Setting `true` auto-stamps `suspended_at`; setting `false` clears `suspended_at` / `suspended_reason`. */
2139
+ suspended?: boolean;
2140
+ /** @description Free-form reason for the suspension (e.g. "abuse: RCE payload"). Stored verbatim for audit purposes. */
2141
+ suspended_reason?: string;
2129
2142
  /** @description user country as iso string */
2130
2143
  country_iso?: string;
2131
2144
  /** @description user birth_date */
@@ -4629,6 +4642,15 @@ export interface operations {
4629
4642
  last_ip?: string | null;
4630
4643
  /** @description Last date and time this user logged in (ISO_8601 format) */
4631
4644
  last_login?: string | null;
4645
+ /**
4646
+ * @description true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.
4647
+ * @default false
4648
+ */
4649
+ suspended: boolean;
4650
+ /** @description ISO 8601 timestamp of when `suspended` was last flipped to true. */
4651
+ suspended_at?: string | null;
4652
+ /** @description Free-form reason recorded when the user was suspended (e.g. "abuse: RCE payload"). */
4653
+ suspended_reason?: string | null;
4632
4654
  /**
4633
4655
  * @description User Metadata
4634
4656
  * @default {}
@@ -4750,6 +4772,15 @@ export interface operations {
4750
4772
  last_ip?: string | null;
4751
4773
  /** @description Last date and time this user logged in (ISO_8601 format) */
4752
4774
  last_login?: string | null;
4775
+ /**
4776
+ * @description true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.
4777
+ * @default false
4778
+ */
4779
+ suspended: boolean;
4780
+ /** @description ISO 8601 timestamp of when `suspended` was last flipped to true. */
4781
+ suspended_at?: string | null;
4782
+ /** @description Free-form reason recorded when the user was suspended (e.g. "abuse: RCE payload"). */
4783
+ suspended_reason?: string | null;
4753
4784
  /**
4754
4785
  * @description User Metadata
4755
4786
  * @default {}
@@ -4809,6 +4840,10 @@ export interface operations {
4809
4840
  phone?: string;
4810
4841
  /** @description Flip the phone verification flag. Setting `true` marks the phone as verified by the admin (`phone_verified_method=manual`). */
4811
4842
  phone_verified?: boolean;
4843
+ /** @description Suspend (`true`) or reinstate (`false`) the user. While suspended, every login flow, token grant, session use and management-API call is rejected. Setting `true` auto-stamps `suspended_at`; setting `false` clears `suspended_at` / `suspended_reason`. */
4844
+ suspended?: boolean;
4845
+ /** @description Free-form reason for the suspension (e.g. "abuse: RCE payload"). Stored verbatim for audit purposes. */
4846
+ suspended_reason?: string;
4812
4847
  /** @description user country as iso string */
4813
4848
  country_iso?: string;
4814
4849
  /** @description user birth_date */
@@ -4907,6 +4942,15 @@ export interface operations {
4907
4942
  last_ip?: string | null;
4908
4943
  /** @description Last date and time this user logged in (ISO_8601 format) */
4909
4944
  last_login?: string | null;
4945
+ /**
4946
+ * @description true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.
4947
+ * @default false
4948
+ */
4949
+ suspended: boolean;
4950
+ /** @description ISO 8601 timestamp of when `suspended` was last flipped to true. */
4951
+ suspended_at?: string | null;
4952
+ /** @description Free-form reason recorded when the user was suspended (e.g. "abuse: RCE payload"). */
4953
+ suspended_reason?: string | null;
4910
4954
  /**
4911
4955
  * @description User Metadata
4912
4956
  * @default {}
@@ -5028,6 +5072,15 @@ export interface operations {
5028
5072
  last_ip?: string | null;
5029
5073
  /** @description Last date and time this user logged in (ISO_8601 format) */
5030
5074
  last_login?: string | null;
5075
+ /**
5076
+ * @description true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.
5077
+ * @default false
5078
+ */
5079
+ suspended: boolean;
5080
+ /** @description ISO 8601 timestamp of when `suspended` was last flipped to true. */
5081
+ suspended_at?: string | null;
5082
+ /** @description Free-form reason recorded when the user was suspended (e.g. "abuse: RCE payload"). */
5083
+ suspended_reason?: string | null;
5031
5084
  /**
5032
5085
  * @description User Metadata
5033
5086
  * @default {}
@@ -8486,6 +8539,15 @@ export interface operations {
8486
8539
  last_ip?: string | null;
8487
8540
  /** @description Last date and time this user logged in (ISO_8601 format) */
8488
8541
  last_login?: string | null;
8542
+ /**
8543
+ * @description true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.
8544
+ * @default false
8545
+ */
8546
+ suspended: boolean;
8547
+ /** @description ISO 8601 timestamp of when `suspended` was last flipped to true. */
8548
+ suspended_at?: string | null;
8549
+ /** @description Free-form reason recorded when the user was suspended (e.g. "abuse: RCE payload"). */
8550
+ suspended_reason?: string | null;
8489
8551
  /**
8490
8552
  * @description User Metadata
8491
8553
  * @default {}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faable/auth-sdk",
3
- "version": "2.4.15",
3
+ "version": "2.4.16",
4
4
  "author": "Marc Pomar <marc@faable.com>",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/spec/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "@faablecloud/auth",
5
5
  "description": "Auth Platform made by Faable. Manage Users and Roles",
6
- "version": "1.23.0",
6
+ "version": "1.24.0",
7
7
  "license": {
8
8
  "name": "private",
9
9
  "url": "https://faable.com/docs/platform/privacy-policy"
@@ -1319,6 +1319,21 @@
1319
1319
  "description": "Last date and time this user logged in (ISO_8601 format)",
1320
1320
  "nullable": true
1321
1321
  },
1322
+ "suspended": {
1323
+ "type": "boolean",
1324
+ "description": "true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.",
1325
+ "default": false
1326
+ },
1327
+ "suspended_at": {
1328
+ "type": "string",
1329
+ "description": "ISO 8601 timestamp of when `suspended` was last flipped to true.",
1330
+ "nullable": true
1331
+ },
1332
+ "suspended_reason": {
1333
+ "type": "string",
1334
+ "description": "Free-form reason recorded when the user was suspended (e.g. \"abuse: RCE payload\").",
1335
+ "nullable": true
1336
+ },
1322
1337
  "user_metadata": {
1323
1338
  "type": "object",
1324
1339
  "properties": {},
@@ -1505,6 +1520,15 @@
1505
1520
  "type": "boolean",
1506
1521
  "description": "Flip the phone verification flag. Setting `true` marks the phone as verified by the admin (`phone_verified_method=manual`)."
1507
1522
  },
1523
+ "suspended": {
1524
+ "type": "boolean",
1525
+ "description": "Suspend (`true`) or reinstate (`false`) the user. While suspended, every login flow, token grant, session use and management-API call is rejected. Setting `true` auto-stamps `suspended_at`; setting `false` clears `suspended_at` / `suspended_reason`."
1526
+ },
1527
+ "suspended_reason": {
1528
+ "type": "string",
1529
+ "maxLength": 512,
1530
+ "description": "Free-form reason for the suspension (e.g. \"abuse: RCE payload\"). Stored verbatim for audit purposes."
1531
+ },
1508
1532
  "country_iso": {
1509
1533
  "type": "string",
1510
1534
  "description": "user country as iso string"
@@ -8308,6 +8332,21 @@
8308
8332
  "description": "Last date and time this user logged in (ISO_8601 format)",
8309
8333
  "nullable": true
8310
8334
  },
8335
+ "suspended": {
8336
+ "type": "boolean",
8337
+ "description": "true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.",
8338
+ "default": false
8339
+ },
8340
+ "suspended_at": {
8341
+ "type": "string",
8342
+ "description": "ISO 8601 timestamp of when `suspended` was last flipped to true.",
8343
+ "nullable": true
8344
+ },
8345
+ "suspended_reason": {
8346
+ "type": "string",
8347
+ "description": "Free-form reason recorded when the user was suspended (e.g. \"abuse: RCE payload\").",
8348
+ "nullable": true
8349
+ },
8311
8350
  "user_metadata": {
8312
8351
  "type": "object",
8313
8352
  "properties": {},
@@ -8641,6 +8680,21 @@
8641
8680
  "description": "Last date and time this user logged in (ISO_8601 format)",
8642
8681
  "nullable": true
8643
8682
  },
8683
+ "suspended": {
8684
+ "type": "boolean",
8685
+ "description": "true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.",
8686
+ "default": false
8687
+ },
8688
+ "suspended_at": {
8689
+ "type": "string",
8690
+ "description": "ISO 8601 timestamp of when `suspended` was last flipped to true.",
8691
+ "nullable": true
8692
+ },
8693
+ "suspended_reason": {
8694
+ "type": "string",
8695
+ "description": "Free-form reason recorded when the user was suspended (e.g. \"abuse: RCE payload\").",
8696
+ "nullable": true
8697
+ },
8644
8698
  "user_metadata": {
8645
8699
  "type": "object",
8646
8700
  "properties": {},
@@ -8724,6 +8778,15 @@
8724
8778
  "type": "boolean",
8725
8779
  "description": "Flip the phone verification flag. Setting `true` marks the phone as verified by the admin (`phone_verified_method=manual`)."
8726
8780
  },
8781
+ "suspended": {
8782
+ "type": "boolean",
8783
+ "description": "Suspend (`true`) or reinstate (`false`) the user. While suspended, every login flow, token grant, session use and management-API call is rejected. Setting `true` auto-stamps `suspended_at`; setting `false` clears `suspended_at` / `suspended_reason`."
8784
+ },
8785
+ "suspended_reason": {
8786
+ "type": "string",
8787
+ "maxLength": 512,
8788
+ "description": "Free-form reason for the suspension (e.g. \"abuse: RCE payload\"). Stored verbatim for audit purposes."
8789
+ },
8727
8790
  "country_iso": {
8728
8791
  "type": "string",
8729
8792
  "description": "user country as iso string"
@@ -9044,6 +9107,21 @@
9044
9107
  "description": "Last date and time this user logged in (ISO_8601 format)",
9045
9108
  "nullable": true
9046
9109
  },
9110
+ "suspended": {
9111
+ "type": "boolean",
9112
+ "description": "true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.",
9113
+ "default": false
9114
+ },
9115
+ "suspended_at": {
9116
+ "type": "string",
9117
+ "description": "ISO 8601 timestamp of when `suspended` was last flipped to true.",
9118
+ "nullable": true
9119
+ },
9120
+ "suspended_reason": {
9121
+ "type": "string",
9122
+ "description": "Free-form reason recorded when the user was suspended (e.g. \"abuse: RCE payload\").",
9123
+ "nullable": true
9124
+ },
9047
9125
  "user_metadata": {
9048
9126
  "type": "object",
9049
9127
  "properties": {},
@@ -9375,6 +9453,21 @@
9375
9453
  "description": "Last date and time this user logged in (ISO_8601 format)",
9376
9454
  "nullable": true
9377
9455
  },
9456
+ "suspended": {
9457
+ "type": "boolean",
9458
+ "description": "true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.",
9459
+ "default": false
9460
+ },
9461
+ "suspended_at": {
9462
+ "type": "string",
9463
+ "description": "ISO 8601 timestamp of when `suspended` was last flipped to true.",
9464
+ "nullable": true
9465
+ },
9466
+ "suspended_reason": {
9467
+ "type": "string",
9468
+ "description": "Free-form reason recorded when the user was suspended (e.g. \"abuse: RCE payload\").",
9469
+ "nullable": true
9470
+ },
9378
9471
  "user_metadata": {
9379
9472
  "type": "object",
9380
9473
  "properties": {},
@@ -17372,6 +17465,21 @@
17372
17465
  "description": "Last date and time this user logged in (ISO_8601 format)",
17373
17466
  "nullable": true
17374
17467
  },
17468
+ "suspended": {
17469
+ "type": "boolean",
17470
+ "description": "true while the user is suspended. A suspended user is rejected at every login flow, token grant, session use and management-API call.",
17471
+ "default": false
17472
+ },
17473
+ "suspended_at": {
17474
+ "type": "string",
17475
+ "description": "ISO 8601 timestamp of when `suspended` was last flipped to true.",
17476
+ "nullable": true
17477
+ },
17478
+ "suspended_reason": {
17479
+ "type": "string",
17480
+ "description": "Free-form reason recorded when the user was suspended (e.g. \"abuse: RCE payload\").",
17481
+ "nullable": true
17482
+ },
17375
17483
  "user_metadata": {
17376
17484
  "type": "object",
17377
17485
  "properties": {},