@faable/auth-sdk 2.4.7 → 2.4.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.
@@ -519,6 +519,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
519
519
  require_number?: boolean | undefined;
520
520
  require_special?: boolean | undefined;
521
521
  } | undefined;
522
+ disable_signup?: boolean | undefined;
522
523
  account: string;
523
524
  metadata: {
524
525
  [key: string]: unknown;
@@ -557,6 +558,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
557
558
  require_number?: boolean | undefined;
558
559
  require_special?: boolean | undefined;
559
560
  } | undefined;
561
+ disable_signup?: boolean | undefined;
560
562
  account: string;
561
563
  metadata: {
562
564
  [key: string]: unknown;
@@ -598,6 +600,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
598
600
  require_number?: boolean | undefined;
599
601
  require_special?: boolean | undefined;
600
602
  } | undefined;
603
+ disable_signup?: boolean | undefined;
601
604
  account: string;
602
605
  metadata: {
603
606
  [key: string]: unknown;
@@ -638,6 +641,7 @@ export declare class FaableAuthApi extends GeneratedFaableAuthApi {
638
641
  require_number?: boolean | undefined;
639
642
  require_special?: boolean | undefined;
640
643
  } | undefined;
644
+ disable_signup?: boolean | undefined;
641
645
  account: string;
642
646
  metadata: {
643
647
  [key: string]: unknown;
@@ -893,6 +893,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
893
893
  require_number?: boolean | undefined;
894
894
  require_special?: boolean | undefined;
895
895
  } | undefined;
896
+ disable_signup?: boolean | undefined;
896
897
  account: string;
897
898
  metadata: {
898
899
  [key: string]: unknown;
@@ -936,6 +937,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
936
937
  require_number?: boolean | undefined;
937
938
  require_special?: boolean | undefined;
938
939
  } | undefined;
940
+ disable_signup?: boolean | undefined;
939
941
  account: string;
940
942
  metadata: {
941
943
  [key: string]: unknown;
@@ -979,6 +981,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
979
981
  require_number?: boolean | undefined;
980
982
  require_special?: boolean | undefined;
981
983
  } | undefined;
984
+ disable_signup?: boolean | undefined;
982
985
  account: string;
983
986
  metadata: {
984
987
  [key: string]: unknown;
@@ -1023,6 +1026,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1023
1026
  require_number?: boolean | undefined;
1024
1027
  require_special?: boolean | undefined;
1025
1028
  } | undefined;
1029
+ disable_signup?: boolean | undefined;
1026
1030
  account: string;
1027
1031
  metadata: {
1028
1032
  [key: string]: unknown;
@@ -1061,6 +1065,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1061
1065
  require_number?: boolean | undefined;
1062
1066
  require_special?: boolean | undefined;
1063
1067
  } | undefined;
1068
+ disable_signup?: boolean | undefined;
1064
1069
  account: string;
1065
1070
  metadata: {
1066
1071
  [key: string]: unknown;
@@ -1102,6 +1107,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1102
1107
  require_number?: boolean | undefined;
1103
1108
  require_special?: boolean | undefined;
1104
1109
  } | undefined;
1110
+ disable_signup?: boolean | undefined;
1105
1111
  account: string;
1106
1112
  metadata: {
1107
1113
  [key: string]: unknown;
@@ -1146,6 +1152,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
1146
1152
  require_number?: boolean | undefined;
1147
1153
  require_special?: boolean | undefined;
1148
1154
  } | undefined;
1155
+ disable_signup?: boolean | undefined;
1149
1156
  account: string;
1150
1157
  metadata: {
1151
1158
  [key: string]: unknown;
@@ -1604,6 +1604,26 @@ export interface paths {
1604
1604
  patch?: never;
1605
1605
  trace?: never;
1606
1606
  };
1607
+ "/dbconnections/signup": {
1608
+ parameters: {
1609
+ query?: never;
1610
+ header?: never;
1611
+ path?: never;
1612
+ cookie?: never;
1613
+ };
1614
+ get?: never;
1615
+ put?: never;
1616
+ /**
1617
+ * Self-service signup
1618
+ * @description Creates a new user and database credential (email + password) in a single call against the tenant database connection. Public and account-scoped (no management token). Gated per-connection by `disable_signup`. The user is created with `email_verified: false`; the account notification settings (`verify_email_auto_send`, `welcome_email_enabled`) drive any follow-up emails. Does not establish a session — the client logs in afterwards.
1619
+ */
1620
+ post: operations["signup"];
1621
+ delete?: never;
1622
+ options?: never;
1623
+ head?: never;
1624
+ patch?: never;
1625
+ trace?: never;
1626
+ };
1607
1627
  }
1608
1628
  export type webhooks = Record<string, never>;
1609
1629
  export interface components {
@@ -1718,6 +1738,8 @@ export interface components {
1718
1738
  require_number?: boolean;
1719
1739
  require_special?: boolean;
1720
1740
  };
1741
+ /** @description When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`. */
1742
+ disable_signup?: boolean;
1721
1743
  /** @description Object is related with this account */
1722
1744
  account: string;
1723
1745
  /**
@@ -1777,6 +1799,7 @@ export interface components {
1777
1799
  require_number?: boolean;
1778
1800
  require_special?: boolean;
1779
1801
  };
1802
+ disable_signup?: boolean;
1780
1803
  /** @description Add Metadata */
1781
1804
  metadata?: {
1782
1805
  [key: string]: unknown;
@@ -1819,6 +1842,7 @@ export interface components {
1819
1842
  require_number?: boolean;
1820
1843
  require_special?: boolean;
1821
1844
  } | null;
1845
+ disable_signup?: boolean;
1822
1846
  };
1823
1847
  /** @description Client */
1824
1848
  Client: {
@@ -3658,6 +3682,7 @@ export interface operations {
3658
3682
  require_number?: boolean;
3659
3683
  require_special?: boolean;
3660
3684
  };
3685
+ disable_signup?: boolean;
3661
3686
  /** @description Add Metadata */
3662
3687
  metadata?: {
3663
3688
  [key: string]: unknown;
@@ -3722,6 +3747,8 @@ export interface operations {
3722
3747
  require_number?: boolean;
3723
3748
  require_special?: boolean;
3724
3749
  };
3750
+ /** @description When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`. */
3751
+ disable_signup?: boolean;
3725
3752
  /** @description Object is related with this account */
3726
3753
  account: string;
3727
3754
  /**
@@ -3807,6 +3834,8 @@ export interface operations {
3807
3834
  require_number?: boolean;
3808
3835
  require_special?: boolean;
3809
3836
  };
3837
+ /** @description When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`. */
3838
+ disable_signup?: boolean;
3810
3839
  /** @description Object is related with this account */
3811
3840
  account: string;
3812
3841
  /**
@@ -3869,6 +3898,7 @@ export interface operations {
3869
3898
  require_number?: boolean;
3870
3899
  require_special?: boolean;
3871
3900
  } | null;
3901
+ disable_signup?: boolean;
3872
3902
  };
3873
3903
  };
3874
3904
  };
@@ -3929,6 +3959,8 @@ export interface operations {
3929
3959
  require_number?: boolean;
3930
3960
  require_special?: boolean;
3931
3961
  };
3962
+ /** @description When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`. */
3963
+ disable_signup?: boolean;
3932
3964
  /** @description Object is related with this account */
3933
3965
  account: string;
3934
3966
  /**
@@ -4014,6 +4046,8 @@ export interface operations {
4014
4046
  require_number?: boolean;
4015
4047
  require_special?: boolean;
4016
4048
  };
4049
+ /** @description When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`. */
4050
+ disable_signup?: boolean;
4017
4051
  /** @description Object is related with this account */
4018
4052
  account: string;
4019
4053
  /**
@@ -9191,4 +9225,39 @@ export interface operations {
9191
9225
  };
9192
9226
  };
9193
9227
  };
9228
+ signup: {
9229
+ parameters: {
9230
+ query?: never;
9231
+ header?: never;
9232
+ path?: never;
9233
+ cookie?: never;
9234
+ };
9235
+ requestBody: {
9236
+ content: {
9237
+ "application/json": {
9238
+ /** @description Email login identifier. */
9239
+ email: string;
9240
+ /** @description Plaintext password (validated against the connection policy, hashed on write). */
9241
+ password: string;
9242
+ name?: string;
9243
+ given_name?: string;
9244
+ family_name?: string;
9245
+ user_metadata?: {
9246
+ [key: string]: unknown;
9247
+ };
9248
+ /** @description Optional connection_name to disambiguate when the tenant has more than one database connection. Defaults to the tenant database connection. */
9249
+ connection?: string;
9250
+ };
9251
+ };
9252
+ };
9253
+ responses: {
9254
+ /** @description Default Response */
9255
+ 200: {
9256
+ headers: {
9257
+ [name: string]: unknown;
9258
+ };
9259
+ content?: never;
9260
+ };
9261
+ };
9262
+ };
9194
9263
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faable/auth-sdk",
3
- "version": "2.4.7",
3
+ "version": "2.4.8",
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.19.1",
6
+ "version": "1.20.0",
7
7
  "license": {
8
8
  "name": "private",
9
9
  "url": "https://faable.com/docs/platform/privacy-policy"
@@ -414,6 +414,10 @@
414
414
  },
415
415
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
416
416
  },
417
+ "disable_signup": {
418
+ "type": "boolean",
419
+ "description": "When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`."
420
+ },
417
421
  "account": {
418
422
  "type": "string",
419
423
  "description": "Object is related with this account"
@@ -579,6 +583,9 @@
579
583
  },
580
584
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
581
585
  },
586
+ "disable_signup": {
587
+ "type": "boolean"
588
+ },
582
589
  "metadata": {
583
590
  "type": "object",
584
591
  "properties": {},
@@ -739,6 +746,9 @@
739
746
  "type": "null"
740
747
  }
741
748
  ]
749
+ },
750
+ "disable_signup": {
751
+ "type": "boolean"
742
752
  }
743
753
  },
744
754
  "description": "Partial update for a Connection. Only the supplied fields are modified. `connection_type` is intentionally excluded — changing it would orphan every identity already linked to this connection.",
@@ -5507,6 +5517,9 @@
5507
5517
  },
5508
5518
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
5509
5519
  },
5520
+ "disable_signup": {
5521
+ "type": "boolean"
5522
+ },
5510
5523
  "metadata": {
5511
5524
  "type": "object",
5512
5525
  "properties": {},
@@ -5718,6 +5731,10 @@
5718
5731
  },
5719
5732
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
5720
5733
  },
5734
+ "disable_signup": {
5735
+ "type": "boolean",
5736
+ "description": "When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`."
5737
+ },
5721
5738
  "account": {
5722
5739
  "type": "string",
5723
5740
  "description": "Object is related with this account"
@@ -5961,6 +5978,10 @@
5961
5978
  },
5962
5979
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
5963
5980
  },
5981
+ "disable_signup": {
5982
+ "type": "boolean",
5983
+ "description": "When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`."
5984
+ },
5964
5985
  "account": {
5965
5986
  "type": "string",
5966
5987
  "description": "Object is related with this account"
@@ -6143,6 +6164,9 @@
6143
6164
  "type": "null"
6144
6165
  }
6145
6166
  ]
6167
+ },
6168
+ "disable_signup": {
6169
+ "type": "boolean"
6146
6170
  }
6147
6171
  },
6148
6172
  "description": "Partial update for a Connection. Only the supplied fields are modified. `connection_type` is intentionally excluded — changing it would orphan every identity already linked to this connection.",
@@ -6359,6 +6383,10 @@
6359
6383
  },
6360
6384
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
6361
6385
  },
6386
+ "disable_signup": {
6387
+ "type": "boolean",
6388
+ "description": "When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`."
6389
+ },
6362
6390
  "account": {
6363
6391
  "type": "string",
6364
6392
  "description": "Object is related with this account"
@@ -6600,6 +6628,10 @@
6600
6628
  },
6601
6629
  "description": "Password policy enforced when writing a password through this database connection (password reset and admin set-password). `level` is an Auth0-style preset (none/low/fair/good/excellent); the dashboard expands it into the explicit rule fields when saving. The rule fields override the preset baseline. When unset on the connection, the server applies the `good` default. Does not affect login."
6602
6630
  },
6631
+ "disable_signup": {
6632
+ "type": "boolean",
6633
+ "description": "When true, the public self-service signup endpoint (`POST /dbconnections/signup`) rejects new registrations against this database connection with `403 signup_disabled`. Defaults to false (signup allowed). Only meaningful on `database` connections; mirrors Auth0 `disable_signup`."
6634
+ },
6603
6635
  "account": {
6604
6636
  "type": "string",
6605
6637
  "description": "Object is related with this account"
@@ -19009,6 +19041,63 @@
19009
19041
  }
19010
19042
  }
19011
19043
  }
19044
+ },
19045
+ "/dbconnections/signup": {
19046
+ "post": {
19047
+ "operationId": "signup",
19048
+ "summary": "Self-service signup",
19049
+ "tags": [
19050
+ "dbconnection"
19051
+ ],
19052
+ "description": "Creates a new user and database credential (email + password) in a single call against the tenant database connection. Public and account-scoped (no management token). Gated per-connection by `disable_signup`. The user is created with `email_verified: false`; the account notification settings (`verify_email_auto_send`, `welcome_email_enabled`) drive any follow-up emails. Does not establish a session — the client logs in afterwards.",
19053
+ "requestBody": {
19054
+ "required": true,
19055
+ "content": {
19056
+ "application/json": {
19057
+ "schema": {
19058
+ "type": "object",
19059
+ "required": [
19060
+ "email",
19061
+ "password"
19062
+ ],
19063
+ "properties": {
19064
+ "email": {
19065
+ "type": "string",
19066
+ "description": "Email login identifier."
19067
+ },
19068
+ "password": {
19069
+ "type": "string",
19070
+ "description": "Plaintext password (validated against the connection policy, hashed on write)."
19071
+ },
19072
+ "name": {
19073
+ "type": "string"
19074
+ },
19075
+ "given_name": {
19076
+ "type": "string"
19077
+ },
19078
+ "family_name": {
19079
+ "type": "string"
19080
+ },
19081
+ "user_metadata": {
19082
+ "type": "object",
19083
+ "additionalProperties": {}
19084
+ },
19085
+ "connection": {
19086
+ "type": "string",
19087
+ "description": "Optional connection_name to disambiguate when the tenant has more than one database connection. Defaults to the tenant database connection."
19088
+ }
19089
+ },
19090
+ "additionalProperties": false
19091
+ }
19092
+ }
19093
+ }
19094
+ },
19095
+ "responses": {
19096
+ "200": {
19097
+ "description": "Default Response"
19098
+ }
19099
+ }
19100
+ }
19012
19101
  }
19013
19102
  },
19014
19103
  "servers": [],