@faable/auth-sdk 2.7.0 → 2.7.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/dist/FaableAuthApi.d.ts +12 -12
- package/dist/api/api-types.d.ts +2 -0
- package/dist/api/generated-client.d.ts +1111 -15
- package/dist/api/generated-client.js +1096 -0
- package/dist/api/types.d.ts +13081 -837
- package/dist/version.js +2 -2
- package/package.json +1 -1
- package/spec/openapi.json +23748 -1010
|
@@ -24,6 +24,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
24
24
|
* Create an Account
|
|
25
25
|
*
|
|
26
26
|
* Creates a new Auth Account. The slug is derived from the name and used to build the default `*.auth.faable.link` domain.
|
|
27
|
+
*
|
|
28
|
+
* @throws {FaableApiError} `team_required` (400) — An Auth Account must belong to a project (team).
|
|
29
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
30
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
31
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
32
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
33
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
34
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
35
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
36
|
+
* @throws {FaableApiError} `account_limit_reached` (409) — The project already has the maximum number of Auth Accounts.
|
|
37
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
38
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
27
39
|
*/
|
|
28
40
|
accountCreate(data: OpBody<"account/create">): Promise<{
|
|
29
41
|
id: string;
|
|
@@ -88,6 +100,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
88
100
|
* Get current Account
|
|
89
101
|
*
|
|
90
102
|
* Returns the Account resolved from request context (header, hostname, or team id). Use `expand` to populate nested references.
|
|
103
|
+
*
|
|
104
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
105
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
106
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
107
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
108
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
109
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
110
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
111
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
91
112
|
*/
|
|
92
113
|
accountCurrent(params?: OpQuery<"account/current">): Promise<{
|
|
93
114
|
id: string;
|
|
@@ -152,14 +173,37 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
152
173
|
* Delete an Account
|
|
153
174
|
*
|
|
154
175
|
* Permanently removes an Account and its associated data. This action cannot be undone.
|
|
176
|
+
*
|
|
177
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
178
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
179
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
180
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
181
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
182
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
183
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
184
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
185
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
186
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
155
187
|
*/
|
|
156
|
-
accountDelete(account_id: string): Promise<
|
|
188
|
+
accountDelete(account_id: string): Promise<void>;
|
|
157
189
|
/**
|
|
158
190
|
* `GET /account/{account_id}` — operationId: `account/get`
|
|
159
191
|
*
|
|
160
192
|
* Get an Account
|
|
161
193
|
*
|
|
162
194
|
* Fetch a single Account by its id. Use `expand` to populate id-only fields (e.g. `default_connection`) inline.
|
|
195
|
+
*
|
|
196
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
197
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
198
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
199
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
200
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
201
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
202
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
203
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
204
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
205
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
206
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
163
207
|
*/
|
|
164
208
|
accountGet(account_id: string, params?: OpQuery<"account/get">): Promise<{
|
|
165
209
|
id: string;
|
|
@@ -224,6 +268,14 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
224
268
|
* Get Account signing keys info
|
|
225
269
|
*
|
|
226
270
|
* Returns metadata for the Account signing keys: the current production kid, the kid queued for next rotation, and all kids currently published in the JWK Set. Does not expose private key material.
|
|
271
|
+
*
|
|
272
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
273
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
274
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
275
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
276
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
277
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
278
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
227
279
|
*/
|
|
228
280
|
accountGetKeys(): Promise<{
|
|
229
281
|
production_kid: string;
|
|
@@ -236,6 +288,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
236
288
|
* List Accounts
|
|
237
289
|
*
|
|
238
290
|
* List Accounts owned by the requesting project/team. Supports cursor pagination and `expand`.
|
|
291
|
+
*
|
|
292
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
293
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
294
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
295
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
296
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
297
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
298
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
299
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
300
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
301
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
302
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
239
303
|
*/
|
|
240
304
|
accountList(params?: Omit<OpQuery<"account/list">, "cursor" | "next">): {
|
|
241
305
|
all: () => Promise<{
|
|
@@ -419,6 +483,14 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
419
483
|
* Recovery channel capabilities for this tenant
|
|
420
484
|
*
|
|
421
485
|
* Which recovery channels the platform can send, whether the plan allows the paid ones, this month's SMS usage against the included amount, and the tenant configuration as resolved. Drives the "Recovery channels" editor in the dashboard.
|
|
486
|
+
*
|
|
487
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
488
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
489
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
490
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
491
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
492
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
493
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
422
494
|
*/
|
|
423
495
|
accountRecoveryChannelsCapabilities(): Promise<{
|
|
424
496
|
provider: {
|
|
@@ -454,6 +526,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
454
526
|
* Rotate Account signing keys
|
|
455
527
|
*
|
|
456
528
|
* Promotes the queued key to production and generates a fresh queued key. The previously-active key is retained inside the JWK Set so tokens already issued remain verifiable via `/.well-known/jwks.json`.
|
|
529
|
+
*
|
|
530
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
531
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
532
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
533
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
534
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
535
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
536
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
537
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
457
538
|
*/
|
|
458
539
|
accountRotateKeys(data: OpBody<"account/rotateKeys">): Promise<{
|
|
459
540
|
rotated_at: string;
|
|
@@ -468,6 +549,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
468
549
|
* Library health for this account
|
|
469
550
|
*
|
|
470
551
|
* Which Faable client libraries this account is being called with, at which versions, and how far behind the latest published release each one is. Versions are observed from the `x-faable-client` header, so an integration that talks raw OIDC shows up only in the traffic breakdown.
|
|
552
|
+
*
|
|
553
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
554
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
555
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
556
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
557
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
558
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
559
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
560
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
471
561
|
*/
|
|
472
562
|
accountSdkHealth(account_id: string): Promise<{
|
|
473
563
|
libraries: {
|
|
@@ -504,6 +594,19 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
504
594
|
* Update an Account
|
|
505
595
|
*
|
|
506
596
|
* Update the Account configuration such as branding (logo and icon URLs).
|
|
597
|
+
*
|
|
598
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
599
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
600
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
601
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
602
|
+
* @throws {FaableApiError} `plan_required` (402) — The setting requires a higher plan. `message` says which.
|
|
603
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
604
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
605
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
606
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
607
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
608
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
609
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
507
610
|
*/
|
|
508
611
|
accountUpdate(account_id: string, data: OpBody<"account/update">): Promise<{
|
|
509
612
|
id: string;
|
|
@@ -566,6 +669,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
566
669
|
* `POST /action` — operationId: `action/create`
|
|
567
670
|
*
|
|
568
671
|
* Create Action
|
|
672
|
+
*
|
|
673
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
674
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
675
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
676
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
677
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
678
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
679
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
680
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
681
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
569
682
|
*/
|
|
570
683
|
actionCreate(data: OpBody<"action/create">): Promise<{
|
|
571
684
|
id: string;
|
|
@@ -586,6 +699,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
586
699
|
* `DELETE /action/{action_id}` — operationId: `action/delete`
|
|
587
700
|
*
|
|
588
701
|
* Delete Action
|
|
702
|
+
*
|
|
703
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
704
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
705
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
706
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
707
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
708
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
709
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
710
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
711
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
712
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
589
713
|
*/
|
|
590
714
|
actionDelete(action_id: string): Promise<{
|
|
591
715
|
id: string;
|
|
@@ -606,6 +730,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
606
730
|
* `GET /action/{action_id}` — operationId: `action/get`
|
|
607
731
|
*
|
|
608
732
|
* Get Action
|
|
733
|
+
*
|
|
734
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
735
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
736
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
737
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
738
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
739
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
740
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
741
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
742
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
743
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
744
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
609
745
|
*/
|
|
610
746
|
actionGet(action_id: string): Promise<{
|
|
611
747
|
id: string;
|
|
@@ -626,6 +762,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
626
762
|
* `GET /action` — operationId: `action/list`
|
|
627
763
|
*
|
|
628
764
|
* List Actions
|
|
765
|
+
*
|
|
766
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
767
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
768
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
769
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
770
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
771
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
772
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
773
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
774
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
775
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
776
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
629
777
|
*/
|
|
630
778
|
actionList(params?: Omit<OpQuery<"action/list">, "cursor" | "next">): {
|
|
631
779
|
all: () => Promise<{
|
|
@@ -681,6 +829,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
681
829
|
* `POST /action/{action_id}` — operationId: `action/update`
|
|
682
830
|
*
|
|
683
831
|
* Update Action
|
|
832
|
+
*
|
|
833
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
834
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
835
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
836
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
837
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
838
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
839
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
840
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
841
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
842
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
843
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
684
844
|
*/
|
|
685
845
|
actionUpdate(action_id: string, data: OpBody<"action/update">): Promise<{
|
|
686
846
|
id: string;
|
|
@@ -701,6 +861,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
701
861
|
* `POST /api` — operationId: `api/create`
|
|
702
862
|
*
|
|
703
863
|
* Create Api
|
|
864
|
+
*
|
|
865
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
866
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
867
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
868
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
869
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
870
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
871
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
872
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
873
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
704
874
|
*/
|
|
705
875
|
apiCreate(data: OpBody<"api/create">): Promise<{
|
|
706
876
|
id: string;
|
|
@@ -733,6 +903,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
733
903
|
* `DELETE /api/{api_id}` — operationId: `api/delete`
|
|
734
904
|
*
|
|
735
905
|
* Delete Api
|
|
906
|
+
*
|
|
907
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
908
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
909
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
910
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
911
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
912
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
913
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
914
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
915
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
916
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
736
917
|
*/
|
|
737
918
|
apiDelete(api_id: string): Promise<{
|
|
738
919
|
id: string;
|
|
@@ -765,6 +946,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
765
946
|
* `GET /api/{api_id}` — operationId: `api/get`
|
|
766
947
|
*
|
|
767
948
|
* Get Api
|
|
949
|
+
*
|
|
950
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
951
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
952
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
953
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
954
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
955
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
956
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
957
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
958
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
959
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
960
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
768
961
|
*/
|
|
769
962
|
apiGet(api_id: string): Promise<{
|
|
770
963
|
id: string;
|
|
@@ -797,6 +990,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
797
990
|
* `GET /api` — operationId: `api/list`
|
|
798
991
|
*
|
|
799
992
|
* List Apis
|
|
993
|
+
*
|
|
994
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
995
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
996
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
997
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
998
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
999
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1000
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1001
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1002
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1003
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1004
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
800
1005
|
*/
|
|
801
1006
|
apiList(params?: Omit<OpQuery<"api/list">, "cursor" | "next">): {
|
|
802
1007
|
all: () => Promise<{
|
|
@@ -888,6 +1093,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
888
1093
|
* `POST /api/{api_id}` — operationId: `api/update`
|
|
889
1094
|
*
|
|
890
1095
|
* Update Api
|
|
1096
|
+
*
|
|
1097
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1098
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1099
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1100
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1101
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1102
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1103
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1104
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1105
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1106
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1107
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
891
1108
|
*/
|
|
892
1109
|
apiUpdate(api_id: string, data: OpBody<"api/update">): Promise<{
|
|
893
1110
|
id: string;
|
|
@@ -920,6 +1137,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
920
1137
|
* `POST /client` — operationId: `client/create`
|
|
921
1138
|
*
|
|
922
1139
|
* Create Client
|
|
1140
|
+
*
|
|
1141
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1142
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1143
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1144
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1145
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1146
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1147
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1148
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1149
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
923
1150
|
*/
|
|
924
1151
|
clientCreate(data: OpBody<"client/create">): Promise<{
|
|
925
1152
|
id: string;
|
|
@@ -985,6 +1212,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
985
1212
|
* `DELETE /client/{client_id}` — operationId: `client/delete`
|
|
986
1213
|
*
|
|
987
1214
|
* Delete Client
|
|
1215
|
+
*
|
|
1216
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1217
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1218
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1219
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1220
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1221
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1222
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1223
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1224
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1225
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
988
1226
|
*/
|
|
989
1227
|
clientDelete(client_id: string): Promise<{
|
|
990
1228
|
id: string;
|
|
@@ -1050,6 +1288,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1050
1288
|
* `GET /client/{client_id}` — operationId: `client/get`
|
|
1051
1289
|
*
|
|
1052
1290
|
* Get Client
|
|
1291
|
+
*
|
|
1292
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1293
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1294
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1295
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1296
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1297
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1298
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1299
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1300
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1301
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1302
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1053
1303
|
*/
|
|
1054
1304
|
clientGet(client_id: string): Promise<{
|
|
1055
1305
|
id: string;
|
|
@@ -1115,6 +1365,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1115
1365
|
* `GET /client` — operationId: `client/list`
|
|
1116
1366
|
*
|
|
1117
1367
|
* List Clients
|
|
1368
|
+
*
|
|
1369
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1370
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1371
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1372
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1373
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1374
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1375
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1376
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1377
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1378
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1379
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1118
1380
|
*/
|
|
1119
1381
|
clientList(params?: Omit<OpQuery<"client/list">, "cursor" | "next">): {
|
|
1120
1382
|
all: () => Promise<{
|
|
@@ -1307,6 +1569,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1307
1569
|
* Rotate a Client's secret
|
|
1308
1570
|
*
|
|
1309
1571
|
* Generates a fresh `client_secret` for the given Client and persists it. The previous secret is invalidated immediately — there is no grace period. Returns the full Client; the dashboard must surface the new secret to the admin once. Existing client_credentials / authorization_code integrations using the old secret will start failing at the token endpoint immediately after this call.
|
|
1572
|
+
*
|
|
1573
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1574
|
+
* @throws {FaableApiError} `client_mismatch` (401) — The client belongs to a different account.
|
|
1575
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1576
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1577
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1578
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1579
|
+
* @throws {FaableApiError} `client_not_found` (404) — No client with that `client_id`.
|
|
1580
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1581
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1582
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1310
1583
|
*/
|
|
1311
1584
|
clientRotateSecret(client_id: string): Promise<{
|
|
1312
1585
|
id: string;
|
|
@@ -1372,6 +1645,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1372
1645
|
* `POST /client/{client_id}` — operationId: `client/update`
|
|
1373
1646
|
*
|
|
1374
1647
|
* Update Client
|
|
1648
|
+
*
|
|
1649
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1650
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1651
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1652
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1653
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1654
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1655
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1656
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1657
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1658
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1659
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1375
1660
|
*/
|
|
1376
1661
|
clientUpdate(client_id: string, data: OpBody<"client/update">): Promise<{
|
|
1377
1662
|
id: string;
|
|
@@ -1437,6 +1722,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1437
1722
|
* `POST /connection` — operationId: `connection/create`
|
|
1438
1723
|
*
|
|
1439
1724
|
* Create Connection
|
|
1725
|
+
*
|
|
1726
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1727
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1728
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1729
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1730
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1731
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1732
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1733
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1734
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1440
1735
|
*/
|
|
1441
1736
|
connectionCreate(data: OpBody<"connection/create">): Promise<{
|
|
1442
1737
|
id: string;
|
|
@@ -1481,6 +1776,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1481
1776
|
* `DELETE /connection/{connection_id}` — operationId: `connection/delete`
|
|
1482
1777
|
*
|
|
1483
1778
|
* Delete Connection
|
|
1779
|
+
*
|
|
1780
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1781
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1782
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1783
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1784
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1785
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1786
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1787
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1788
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1789
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1484
1790
|
*/
|
|
1485
1791
|
connectionDelete(connection_id: string): Promise<{
|
|
1486
1792
|
id: string;
|
|
@@ -1525,6 +1831,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1525
1831
|
* `GET /connection/{connection_id}` — operationId: `connection/get`
|
|
1526
1832
|
*
|
|
1527
1833
|
* Get Connection
|
|
1834
|
+
*
|
|
1835
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1836
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1837
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1838
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1839
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1840
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1841
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1842
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1843
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1844
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1845
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1528
1846
|
*/
|
|
1529
1847
|
connectionGet(connection_id: string): Promise<{
|
|
1530
1848
|
id: string;
|
|
@@ -1569,6 +1887,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1569
1887
|
* `GET /connection` — operationId: `connection/list`
|
|
1570
1888
|
*
|
|
1571
1889
|
* List Connections
|
|
1890
|
+
*
|
|
1891
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1892
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1893
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1894
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1895
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1896
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1897
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1898
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1899
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1900
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1901
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1572
1902
|
*/
|
|
1573
1903
|
connectionList(params?: Omit<OpQuery<"connection/list">, "cursor" | "next">): {
|
|
1574
1904
|
all: () => Promise<{
|
|
@@ -1696,6 +2026,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1696
2026
|
* `POST /connection/{connection_id}` — operationId: `connection/update`
|
|
1697
2027
|
*
|
|
1698
2028
|
* Update Connection
|
|
2029
|
+
*
|
|
2030
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2031
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2032
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2033
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2034
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2035
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2036
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2037
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2038
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2039
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2040
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1699
2041
|
*/
|
|
1700
2042
|
connectionUpdate(connection_id: string, data: OpBody<"connection/update">): Promise<{
|
|
1701
2043
|
id: string;
|
|
@@ -1740,6 +2082,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1740
2082
|
* `POST /credentials` — operationId: `credentials/create`
|
|
1741
2083
|
*
|
|
1742
2084
|
* Create Credentials
|
|
2085
|
+
*
|
|
2086
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2087
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2088
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2089
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2090
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2091
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2092
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2093
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2094
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1743
2095
|
*/
|
|
1744
2096
|
credentialsCreate(data: OpBody<"credentials/create">): Promise<{
|
|
1745
2097
|
id: string;
|
|
@@ -1758,6 +2110,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1758
2110
|
* `DELETE /credentials/{credentials_id}` — operationId: `credentials/delete`
|
|
1759
2111
|
*
|
|
1760
2112
|
* Delete Credentials
|
|
2113
|
+
*
|
|
2114
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2115
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2116
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2117
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2118
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2119
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2120
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2121
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2122
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2123
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1761
2124
|
*/
|
|
1762
2125
|
credentialsDelete(credentials_id: string): Promise<{
|
|
1763
2126
|
id: string;
|
|
@@ -1776,6 +2139,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1776
2139
|
* `GET /credentials/{credentials_id}` — operationId: `credentials/get`
|
|
1777
2140
|
*
|
|
1778
2141
|
* Get Credentials
|
|
2142
|
+
*
|
|
2143
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2144
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2145
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2146
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2147
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2148
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2149
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2150
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2151
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2152
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2153
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1779
2154
|
*/
|
|
1780
2155
|
credentialsGet(credentials_id: string, params?: OpQuery<"credentials/get">): Promise<{
|
|
1781
2156
|
id: string;
|
|
@@ -1794,6 +2169,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1794
2169
|
* `GET /credentials` — operationId: `credentials/list`
|
|
1795
2170
|
*
|
|
1796
2171
|
* List Credentialss
|
|
2172
|
+
*
|
|
2173
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2174
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2175
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2176
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2177
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2178
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2179
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2180
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2181
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2182
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2183
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1797
2184
|
*/
|
|
1798
2185
|
credentialsList(params?: Omit<OpQuery<"credentials/list">, "cursor" | "next">): {
|
|
1799
2186
|
all: () => Promise<{
|
|
@@ -1845,6 +2232,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1845
2232
|
* Set a credential's password
|
|
1846
2233
|
*
|
|
1847
2234
|
* 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 confirmation email is only sent when an EXISTING password is rotated: setting the first password on a credential that had none is a creation, not a change. The password is never returned.
|
|
2235
|
+
*
|
|
2236
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2237
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2238
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2239
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2240
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2241
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2242
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2243
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1848
2244
|
*/
|
|
1849
2245
|
credentialsSetPassword(credentials_id: string, data: OpBody<"credentials/setPassword">): Promise<{
|
|
1850
2246
|
id: string;
|
|
@@ -1863,6 +2259,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1863
2259
|
* `POST /credentials/{credentials_id}` — operationId: `credentials/update`
|
|
1864
2260
|
*
|
|
1865
2261
|
* Update Credentials
|
|
2262
|
+
*
|
|
2263
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2264
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2265
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2266
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2267
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2268
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2269
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2270
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2271
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2272
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2273
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1866
2274
|
*/
|
|
1867
2275
|
credentialsUpdate(credentials_id: string, data: OpBody<"credentials/update">): Promise<{
|
|
1868
2276
|
id: string;
|
|
@@ -1881,6 +2289,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1881
2289
|
* `POST /customdomain` — operationId: `customdomain/create`
|
|
1882
2290
|
*
|
|
1883
2291
|
* Create Customdomain
|
|
2292
|
+
*
|
|
2293
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2294
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2295
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2296
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2297
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2298
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2299
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2300
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2301
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1884
2302
|
*/
|
|
1885
2303
|
customdomainCreate(data: OpBody<"customdomain/create">): Promise<{
|
|
1886
2304
|
id: string;
|
|
@@ -1910,6 +2328,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1910
2328
|
* `DELETE /customdomain/{customdomain_id}` — operationId: `customdomain/delete`
|
|
1911
2329
|
*
|
|
1912
2330
|
* Delete Customdomain
|
|
2331
|
+
*
|
|
2332
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2333
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2334
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2335
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2336
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2337
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2338
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2339
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2340
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2341
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1913
2342
|
*/
|
|
1914
2343
|
customdomainDelete(customdomain_id: string): Promise<{
|
|
1915
2344
|
id: string;
|
|
@@ -1939,6 +2368,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1939
2368
|
* `GET /customdomain/{customdomain_id}` — operationId: `customdomain/get`
|
|
1940
2369
|
*
|
|
1941
2370
|
* Get Customdomain
|
|
2371
|
+
*
|
|
2372
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2373
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2374
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2375
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2376
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2377
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2378
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2379
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2380
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2381
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2382
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1942
2383
|
*/
|
|
1943
2384
|
customdomainGet(customdomain_id: string): Promise<{
|
|
1944
2385
|
id: string;
|
|
@@ -1968,6 +2409,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
1968
2409
|
* `GET /customdomain` — operationId: `customdomain/list`
|
|
1969
2410
|
*
|
|
1970
2411
|
* List Customdomains
|
|
2412
|
+
*
|
|
2413
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2414
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2415
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2416
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2417
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2418
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2419
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2420
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2421
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2422
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2423
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
1971
2424
|
*/
|
|
1972
2425
|
customdomainList(params?: Omit<OpQuery<"customdomain/list">, "cursor" | "next">): {
|
|
1973
2426
|
all: () => Promise<{
|
|
@@ -2052,12 +2505,31 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2052
2505
|
* Trigger a domain verification check now
|
|
2053
2506
|
*
|
|
2054
2507
|
* Forces an immediate DNS re-check of a Custom Domain in any state. Rate-limited to one check per minute. A verified (ACTIVE) domain stays ACTIVE while it is re-checked; any other state moves to VERIFYING.
|
|
2508
|
+
*
|
|
2509
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2510
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2511
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2512
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2513
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2514
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2515
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2516
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2055
2517
|
*/
|
|
2056
2518
|
customdomainRetry(customdomain_id: string): Promise<void>;
|
|
2057
2519
|
/**
|
|
2058
2520
|
* `POST /identity` — operationId: `identity/create`
|
|
2059
2521
|
*
|
|
2060
2522
|
* Create Identity
|
|
2523
|
+
*
|
|
2524
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2525
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2526
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2527
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2528
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2529
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2530
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2531
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2532
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2061
2533
|
*/
|
|
2062
2534
|
identityCreate(data: OpBody<"identity/create">): Promise<{
|
|
2063
2535
|
id: string;
|
|
@@ -2080,6 +2552,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2080
2552
|
* `DELETE /identity/{identity_id}` — operationId: `identity/delete`
|
|
2081
2553
|
*
|
|
2082
2554
|
* Delete Identity
|
|
2555
|
+
*
|
|
2556
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2557
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2558
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2559
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2560
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2561
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2562
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2563
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2564
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2565
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2083
2566
|
*/
|
|
2084
2567
|
identityDelete(identity_id: string): Promise<{
|
|
2085
2568
|
id: string;
|
|
@@ -2102,6 +2585,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2102
2585
|
* `GET /identity/{identity_id}` — operationId: `identity/get`
|
|
2103
2586
|
*
|
|
2104
2587
|
* Get Identity
|
|
2588
|
+
*
|
|
2589
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2590
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2591
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2592
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2593
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2594
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2595
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2596
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2597
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2598
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2599
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2105
2600
|
*/
|
|
2106
2601
|
identityGet(identity_id: string, params?: OpQuery<"identity/get">): Promise<{
|
|
2107
2602
|
id: string;
|
|
@@ -2126,6 +2621,19 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2126
2621
|
* Get a guaranteed-valid provider access_token
|
|
2127
2622
|
*
|
|
2128
2623
|
* Returns the identity's upstream provider `access_token`, refreshing it transparently via the stored `refresh_token` when it is (about to be) expired. Pass `?fresh=true` to force a refresh. Fails with 400 when the token is expired and no `refresh_token` is available (the user must re-authorize).
|
|
2624
|
+
*
|
|
2625
|
+
* @throws {FaableApiError} `connection_misconfigured` (400) — The connection is missing settings needed to talk to its provider.
|
|
2626
|
+
* @throws {FaableApiError} `no_provider_token` (400) — The identity holds no provider access token.
|
|
2627
|
+
* @throws {FaableApiError} `no_refresh_token` (400) — The identity holds no provider refresh token, so it cannot be refreshed.
|
|
2628
|
+
* @throws {FaableApiError} `provider_error` (400) — The upstream identity provider returned an error. `message` carries it.
|
|
2629
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2630
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2631
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2632
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2633
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2634
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2635
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2636
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2129
2637
|
*/
|
|
2130
2638
|
identityGetProviderToken(identity_id: string, params?: OpQuery<"identity/getProviderToken">): Promise<{
|
|
2131
2639
|
access_token: string;
|
|
@@ -2136,6 +2644,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2136
2644
|
* `GET /identity` — operationId: `identity/list`
|
|
2137
2645
|
*
|
|
2138
2646
|
* List Identitys
|
|
2647
|
+
*
|
|
2648
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2649
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2650
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2651
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2652
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2653
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2654
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2655
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2656
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2657
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2658
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2139
2659
|
*/
|
|
2140
2660
|
identityList(params?: Omit<OpQuery<"identity/list">, "cursor" | "next">): {
|
|
2141
2661
|
all: () => Promise<{
|
|
@@ -2199,6 +2719,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2199
2719
|
* SMS sent per tenant in a month (platform)
|
|
2200
2720
|
*
|
|
2201
2721
|
* Per-account count of recovery/verification SMS sent in the given month, read from the monthly quota counters. Consumed by the billing usage job. Platform token with `read:usage`.
|
|
2722
|
+
*
|
|
2723
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2724
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2725
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2726
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2727
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2728
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2729
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2730
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2202
2731
|
*/
|
|
2203
2732
|
internalSmsUsage(params?: OpQuery<"internal/smsUsage">): Promise<{
|
|
2204
2733
|
month: string;
|
|
@@ -2212,6 +2741,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2212
2741
|
* `GET /log/{log_id}` — operationId: `log/get`
|
|
2213
2742
|
*
|
|
2214
2743
|
* Get Log
|
|
2744
|
+
*
|
|
2745
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2746
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2747
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2748
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2749
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2750
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2751
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2752
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2753
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2754
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2755
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2215
2756
|
*/
|
|
2216
2757
|
logGet(log_id: string, params?: OpQuery<"log/get">): Promise<{
|
|
2217
2758
|
id: string;
|
|
@@ -2237,6 +2778,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2237
2778
|
* `GET /log` — operationId: `log/list`
|
|
2238
2779
|
*
|
|
2239
2780
|
* List Logs
|
|
2781
|
+
*
|
|
2782
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2783
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2784
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2785
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2786
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2787
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2788
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2789
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2790
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2791
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2792
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2240
2793
|
*/
|
|
2241
2794
|
logList(params?: Omit<OpQuery<"log/list">, "cursor" | "next">): {
|
|
2242
2795
|
all: () => Promise<{
|
|
@@ -2307,6 +2860,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2307
2860
|
* `POST /loginflow` — operationId: `loginflow/create`
|
|
2308
2861
|
*
|
|
2309
2862
|
* Create Loginflow
|
|
2863
|
+
*
|
|
2864
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2865
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2866
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2867
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2868
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2869
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2870
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2871
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2872
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2310
2873
|
*/
|
|
2311
2874
|
loginflowCreate(data: OpBody<"loginflow/create">): Promise<{
|
|
2312
2875
|
id: string;
|
|
@@ -2380,6 +2943,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2380
2943
|
* `DELETE /loginflow/{loginflow_id}` — operationId: `loginflow/delete`
|
|
2381
2944
|
*
|
|
2382
2945
|
* Delete Loginflow
|
|
2946
|
+
*
|
|
2947
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2948
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2949
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2950
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2951
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2952
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2953
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2954
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2955
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2956
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2383
2957
|
*/
|
|
2384
2958
|
loginflowDelete(loginflow_id: string): Promise<{
|
|
2385
2959
|
id: string;
|
|
@@ -2453,6 +3027,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2453
3027
|
* `GET /loginflow/{loginflow_id}` — operationId: `loginflow/get`
|
|
2454
3028
|
*
|
|
2455
3029
|
* Get Loginflow
|
|
3030
|
+
*
|
|
3031
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
3032
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
3033
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3034
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3035
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3036
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3037
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3038
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
3039
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3040
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3041
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2456
3042
|
*/
|
|
2457
3043
|
loginflowGet(loginflow_id: string): Promise<{
|
|
2458
3044
|
id: string;
|
|
@@ -2526,6 +3112,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2526
3112
|
* `GET /loginflow` — operationId: `loginflow/list`
|
|
2527
3113
|
*
|
|
2528
3114
|
* List Loginflows
|
|
3115
|
+
*
|
|
3116
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
3117
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
3118
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
3119
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3120
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3121
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3122
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3123
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3124
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3125
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3126
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2529
3127
|
*/
|
|
2530
3128
|
loginflowList(params?: Omit<OpQuery<"loginflow/list">, "cursor" | "next">): {
|
|
2531
3129
|
all: () => Promise<{
|
|
@@ -2742,6 +3340,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2742
3340
|
* Start a custom flow from what runs today
|
|
2743
3341
|
*
|
|
2744
3342
|
* Creates a login flow whose draft is the graph the account (or, with `client_id`, that client) currently runs — compiled from its settings — and binds it. Nothing changes for logins until the flow is published: a bound flow with no published graph keeps running the compiled one. Never a blank canvas: customising always starts from the tenant's own behaviour.
|
|
3343
|
+
*
|
|
3344
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3345
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3346
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3347
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3348
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3349
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3350
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3351
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2745
3352
|
*/
|
|
2746
3353
|
loginflowMaterialize(data: OpBody<"loginflow/materialize">): Promise<{
|
|
2747
3354
|
id: string;
|
|
@@ -2817,6 +3424,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2817
3424
|
* Try the draft on a real login, in your browser only
|
|
2818
3425
|
*
|
|
2819
3426
|
* Returns a short-lived token. Open `/authorize?…&flow_preview=<token>` (or the hosted login with the same parameter) and that login runs the DRAFT of this flow instead of what is published, for that browser only. Nothing is published.
|
|
3427
|
+
*
|
|
3428
|
+
* @throws {FaableApiError} `flow_not_found` (400) — The login flow does not exist in this account.
|
|
3429
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3430
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3431
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3432
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3433
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3434
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3435
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3436
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2820
3437
|
*/
|
|
2821
3438
|
loginflowPreviewToken(loginflow_id: string): Promise<{
|
|
2822
3439
|
token: string;
|
|
@@ -2828,6 +3445,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2828
3445
|
* Make the draft the graph logins run
|
|
2829
3446
|
*
|
|
2830
3447
|
* Validates the draft and freezes it as `published` under its current revision; the previous published graph moves to `history`. Logins already in flight keep the revision they started on. Refused with the list of issues when the draft does not validate.
|
|
3448
|
+
*
|
|
3449
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3450
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3451
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3452
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3453
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3454
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3455
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3456
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2831
3457
|
*/
|
|
2832
3458
|
loginflowPublish(loginflow_id: string, data: OpBody<"loginflow/publish">): Promise<{
|
|
2833
3459
|
id: string;
|
|
@@ -2903,6 +3529,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2903
3529
|
* The graph this account (or client) runs right now
|
|
2904
3530
|
*
|
|
2905
3531
|
* What a login actually walks: the published graph of the bound flow, or the graph compiled from the settings when nothing is bound or published. With `client_id`, resolved for that client (its own flow, else the account's, else compiled from its overrides). The bound flow, if any, comes along with its draft so an editor can show both.
|
|
3532
|
+
*
|
|
3533
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3534
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3535
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3536
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3537
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3538
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3539
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3540
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2906
3541
|
*/
|
|
2907
3542
|
loginflowResolved(params?: OpQuery<"loginflow/resolved">): Promise<{
|
|
2908
3543
|
source: "compiled" | "published";
|
|
@@ -2957,6 +3592,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2957
3592
|
* Run a previously published revision again
|
|
2958
3593
|
*
|
|
2959
3594
|
* Makes the named revision from `history` the published graph; the one being replaced moves to `history`. The draft is not touched.
|
|
3595
|
+
*
|
|
3596
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3597
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3598
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3599
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3600
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3601
|
+
* @throws {FaableApiError} `revision_not_found` (404) — The revision is not in the flow history.
|
|
3602
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3603
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3604
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2960
3605
|
*/
|
|
2961
3606
|
loginflowRollback(loginflow_id: string, data: OpBody<"loginflow/rollback">): Promise<{
|
|
2962
3607
|
id: string;
|
|
@@ -3030,6 +3675,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3030
3675
|
* `POST /loginflow/{loginflow_id}` — operationId: `loginflow/update`
|
|
3031
3676
|
*
|
|
3032
3677
|
* Update Loginflow
|
|
3678
|
+
*
|
|
3679
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
3680
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
3681
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3682
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3683
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3684
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3685
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3686
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
3687
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3688
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3689
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3033
3690
|
*/
|
|
3034
3691
|
loginflowUpdate(loginflow_id: string, data: OpBody<"loginflow/update">): Promise<{
|
|
3035
3692
|
id: string;
|
|
@@ -3103,6 +3760,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3103
3760
|
* `POST /loginflow/{loginflow_id}/validate` — operationId: `loginflow/validate`
|
|
3104
3761
|
*
|
|
3105
3762
|
* Check a draft against the rules a publish enforces
|
|
3763
|
+
*
|
|
3764
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3765
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3766
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3767
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3768
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3769
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3770
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3771
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3106
3772
|
*/
|
|
3107
3773
|
loginflowValidate(loginflow_id: string, data: OpBody<"loginflow/validate">): Promise<{
|
|
3108
3774
|
ok: boolean;
|
|
@@ -3117,6 +3783,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3117
3783
|
* `POST /notificationsubscription` — operationId: `notificationsubscription/create`
|
|
3118
3784
|
*
|
|
3119
3785
|
* Create Notificationsubscription
|
|
3786
|
+
*
|
|
3787
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
3788
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3789
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3790
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3791
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3792
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3793
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3794
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3795
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3120
3796
|
*/
|
|
3121
3797
|
notificationsubscriptionCreate(data: OpBody<"notificationsubscription/create">): Promise<{
|
|
3122
3798
|
id: string;
|
|
@@ -3152,6 +3828,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3152
3828
|
* `DELETE /notificationsubscription/{notificationsubscription_id}` — operationId: `notificationsubscription/delete`
|
|
3153
3829
|
*
|
|
3154
3830
|
* Delete Notificationsubscription
|
|
3831
|
+
*
|
|
3832
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
3833
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3834
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3835
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3836
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3837
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3838
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
3839
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3840
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3841
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3155
3842
|
*/
|
|
3156
3843
|
notificationsubscriptionDelete(notificationsubscription_id: string): Promise<{
|
|
3157
3844
|
id: string;
|
|
@@ -3187,6 +3874,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3187
3874
|
* `GET /notificationsubscription/{notificationsubscription_id}` — operationId: `notificationsubscription/get`
|
|
3188
3875
|
*
|
|
3189
3876
|
* Get Notificationsubscription
|
|
3877
|
+
*
|
|
3878
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
3879
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
3880
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3881
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3882
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3883
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3884
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3885
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
3886
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3887
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3888
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3190
3889
|
*/
|
|
3191
3890
|
notificationsubscriptionGet(notificationsubscription_id: string): Promise<{
|
|
3192
3891
|
id: string;
|
|
@@ -3222,6 +3921,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3222
3921
|
* `GET /notificationsubscription` — operationId: `notificationsubscription/list`
|
|
3223
3922
|
*
|
|
3224
3923
|
* List Notificationsubscriptions
|
|
3924
|
+
*
|
|
3925
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
3926
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
3927
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
3928
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
3929
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
3930
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
3931
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
3932
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
3933
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
3934
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
3935
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3225
3936
|
*/
|
|
3226
3937
|
notificationsubscriptionList(params?: Omit<OpQuery<"notificationsubscription/list">, "cursor" | "next">): {
|
|
3227
3938
|
all: () => Promise<({
|
|
@@ -3322,6 +4033,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3322
4033
|
* `POST /notificationsubscription/{notificationsubscription_id}` — operationId: `notificationsubscription/update`
|
|
3323
4034
|
*
|
|
3324
4035
|
* Update Notificationsubscription
|
|
4036
|
+
*
|
|
4037
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4038
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4039
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4040
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4041
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4042
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4043
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4044
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4045
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4046
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4047
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3325
4048
|
*/
|
|
3326
4049
|
notificationsubscriptionUpdate(notificationsubscription_id: string, data: OpBody<"notificationsubscription/update">): Promise<{
|
|
3327
4050
|
id: string;
|
|
@@ -3357,12 +4080,33 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3357
4080
|
* `POST /role/{role_id}/users` — operationId: `role/assign_users`
|
|
3358
4081
|
*
|
|
3359
4082
|
* Assign Users to Role
|
|
4083
|
+
*
|
|
4084
|
+
* @throws {FaableApiError} `invalid_role` (400) — The role belongs to another account.
|
|
4085
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4086
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4087
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4088
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4089
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4090
|
+
* @throws {FaableApiError} `role_not_found` (404) — No role with that id in this account.
|
|
4091
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4092
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4093
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3360
4094
|
*/
|
|
3361
4095
|
roleAssignUsers(role_id: string, data: OpBody<"role/assign_users">): Promise<void>;
|
|
3362
4096
|
/**
|
|
3363
4097
|
* `POST /role` — operationId: `role/create`
|
|
3364
4098
|
*
|
|
3365
4099
|
* Create Role
|
|
4100
|
+
*
|
|
4101
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4102
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4103
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4104
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4105
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4106
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4107
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4108
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4109
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3366
4110
|
*/
|
|
3367
4111
|
roleCreate(data: OpBody<"role/create">): Promise<{
|
|
3368
4112
|
id: string;
|
|
@@ -3379,6 +4123,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3379
4123
|
* `DELETE /role/{role_id}` — operationId: `role/delete`
|
|
3380
4124
|
*
|
|
3381
4125
|
* Delete Role
|
|
4126
|
+
*
|
|
4127
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4128
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4129
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4130
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4131
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4132
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4133
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4134
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4135
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4136
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3382
4137
|
*/
|
|
3383
4138
|
roleDelete(role_id: string): Promise<{
|
|
3384
4139
|
id: string;
|
|
@@ -3395,6 +4150,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3395
4150
|
* `GET /role/{role_id}` — operationId: `role/get`
|
|
3396
4151
|
*
|
|
3397
4152
|
* Get Role
|
|
4153
|
+
*
|
|
4154
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4155
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4156
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4157
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4158
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4159
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4160
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4161
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4162
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4163
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4164
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3398
4165
|
*/
|
|
3399
4166
|
roleGet(role_id: string): Promise<{
|
|
3400
4167
|
id: string;
|
|
@@ -3411,6 +4178,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3411
4178
|
* `GET /role` — operationId: `role/list`
|
|
3412
4179
|
*
|
|
3413
4180
|
* List Roles
|
|
4181
|
+
*
|
|
4182
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
4183
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4184
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
4185
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4186
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4187
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4188
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4189
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4190
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4191
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4192
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3414
4193
|
*/
|
|
3415
4194
|
roleList(params?: Omit<OpQuery<"role/list">, "cursor" | "next">): {
|
|
3416
4195
|
all: () => Promise<{
|
|
@@ -3454,6 +4233,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3454
4233
|
* `POST /role/{role_id}` — operationId: `role/update`
|
|
3455
4234
|
*
|
|
3456
4235
|
* Update Role
|
|
4236
|
+
*
|
|
4237
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4238
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4239
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4240
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4241
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4242
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4243
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4244
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4245
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4246
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4247
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3457
4248
|
*/
|
|
3458
4249
|
roleUpdate(role_id: string, data: OpBody<"role/update">): Promise<{
|
|
3459
4250
|
id: string;
|
|
@@ -3470,6 +4261,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3470
4261
|
* `GET /role/{role_id}/users` — operationId: `role/users`
|
|
3471
4262
|
*
|
|
3472
4263
|
* List Users with Role
|
|
4264
|
+
*
|
|
4265
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4266
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4267
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4268
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4269
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4270
|
+
* @throws {FaableApiError} `role_not_found` (404) — No role with that id in this account.
|
|
4271
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4272
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4273
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3473
4274
|
*/
|
|
3474
4275
|
roleUsers(role_id: string, params?: Omit<OpQuery<"role/users">, "cursor" | "next">): {
|
|
3475
4276
|
all: () => Promise<{
|
|
@@ -3513,6 +4314,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3513
4314
|
* `POST /rolemember` — operationId: `rolemember/create`
|
|
3514
4315
|
*
|
|
3515
4316
|
* Create Rolemember
|
|
4317
|
+
*
|
|
4318
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4319
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4320
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4321
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4322
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4323
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4324
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4325
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4326
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3516
4327
|
*/
|
|
3517
4328
|
rolememberCreate(data: OpBody<"rolemember/create">): Promise<{
|
|
3518
4329
|
id: string;
|
|
@@ -3529,6 +4340,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3529
4340
|
* `DELETE /rolemember/{rolemember_id}` — operationId: `rolemember/delete`
|
|
3530
4341
|
*
|
|
3531
4342
|
* Delete Rolemember
|
|
4343
|
+
*
|
|
4344
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4345
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4346
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4347
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4348
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4349
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4350
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4351
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4352
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4353
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3532
4354
|
*/
|
|
3533
4355
|
rolememberDelete(rolemember_id: string): Promise<{
|
|
3534
4356
|
id: string;
|
|
@@ -3545,6 +4367,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3545
4367
|
* `GET /rolemember/{rolemember_id}` — operationId: `rolemember/get`
|
|
3546
4368
|
*
|
|
3547
4369
|
* Get Rolemember
|
|
4370
|
+
*
|
|
4371
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4372
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4373
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4374
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4375
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4376
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4377
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4378
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4379
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4380
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4381
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3548
4382
|
*/
|
|
3549
4383
|
rolememberGet(rolemember_id: string, params?: OpQuery<"rolemember/get">): Promise<{
|
|
3550
4384
|
id: string;
|
|
@@ -3561,6 +4395,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3561
4395
|
* `GET /rolemember` — operationId: `rolemember/list`
|
|
3562
4396
|
*
|
|
3563
4397
|
* List Rolemembers
|
|
4398
|
+
*
|
|
4399
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
4400
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4401
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
4402
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4403
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4404
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4405
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4406
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4407
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4408
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4409
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3564
4410
|
*/
|
|
3565
4411
|
rolememberList(params?: Omit<OpQuery<"rolemember/list">, "cursor" | "next">): {
|
|
3566
4412
|
all: () => Promise<{
|
|
@@ -3606,6 +4452,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3606
4452
|
* Add Users to a Team
|
|
3607
4453
|
*
|
|
3608
4454
|
* Adds one or more Users as members of the given Team. Returns the resulting TeamMember record.
|
|
4455
|
+
*
|
|
4456
|
+
* @throws {FaableApiError} `already_member` (400) — The user is already a member of the team.
|
|
4457
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4458
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4459
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4460
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4461
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4462
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4463
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4464
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3609
4465
|
*/
|
|
3610
4466
|
teamAddMembers(team_id: string, data: OpBody<"team/addMembers">): Promise<{
|
|
3611
4467
|
id: string;
|
|
@@ -3625,6 +4481,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3625
4481
|
* Check User is member of a Team
|
|
3626
4482
|
*
|
|
3627
4483
|
* Returns the TeamMember record if the User belongs to the given Team, or 404 otherwise.
|
|
4484
|
+
*
|
|
4485
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4486
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4487
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4488
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4489
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4490
|
+
* @throws {FaableApiError} `not_a_member` (404) — The user is not a member of the team.
|
|
4491
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4492
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4493
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3628
4494
|
*/
|
|
3629
4495
|
teamCheckMember(team_id: string, user_id: string, params?: OpQuery<"team/checkMember">): Promise<{
|
|
3630
4496
|
id: string;
|
|
@@ -3642,6 +4508,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3642
4508
|
* `POST /team` — operationId: `team/create`
|
|
3643
4509
|
*
|
|
3644
4510
|
* Create Team
|
|
4511
|
+
*
|
|
4512
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4513
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4514
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4515
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4516
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4517
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4518
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4519
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4520
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3645
4521
|
*/
|
|
3646
4522
|
teamCreate(data: OpBody<"team/create">): Promise<{
|
|
3647
4523
|
id: string;
|
|
@@ -3660,6 +4536,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3660
4536
|
* `DELETE /team/{team_id}` — operationId: `team/delete`
|
|
3661
4537
|
*
|
|
3662
4538
|
* Delete Team
|
|
4539
|
+
*
|
|
4540
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4541
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4542
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4543
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4544
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4545
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4546
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4547
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4548
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4549
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3663
4550
|
*/
|
|
3664
4551
|
teamDelete(team_id: string): Promise<{
|
|
3665
4552
|
id: string;
|
|
@@ -3678,6 +4565,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3678
4565
|
* `GET /team/{team_id}` — operationId: `team/get`
|
|
3679
4566
|
*
|
|
3680
4567
|
* Get Team
|
|
4568
|
+
*
|
|
4569
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4570
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4571
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4572
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4573
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4574
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4575
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4576
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4577
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4578
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4579
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3681
4580
|
*/
|
|
3682
4581
|
teamGet(team_id: string): Promise<{
|
|
3683
4582
|
id: string;
|
|
@@ -3698,6 +4597,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3698
4597
|
* Invite a user to a Team by email
|
|
3699
4598
|
*
|
|
3700
4599
|
* Invites a user by email. `mode='auto'` (default) adds the user directly when the email already corresponds to a user in this tenant and falls back to a ticketed invite + email otherwise. `mode='invite'` always issues a ticket + email even when the user exists. Re-inviting the same email to the same team invalidates the previous pending invite.
|
|
4600
|
+
*
|
|
4601
|
+
* @throws {FaableApiError} `invite_used` (400) — The invite was already accepted.
|
|
4602
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4603
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4604
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4605
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4606
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4607
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4608
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4609
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3701
4610
|
*/
|
|
3702
4611
|
teamInvite(team_id: string, data: OpBody<"team/invite">): Promise<{
|
|
3703
4612
|
status: "invited" | "added";
|
|
@@ -3719,6 +4628,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3719
4628
|
* `GET /team` — operationId: `team/list`
|
|
3720
4629
|
*
|
|
3721
4630
|
* List Teams
|
|
4631
|
+
*
|
|
4632
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
4633
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4634
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
4635
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4636
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4637
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4638
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4639
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4640
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4641
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4642
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3722
4643
|
*/
|
|
3723
4644
|
teamList(params?: Omit<OpQuery<"team/list">, "cursor" | "next">): {
|
|
3724
4645
|
all: () => Promise<{
|
|
@@ -3770,6 +4691,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3770
4691
|
* List pending invites for a Team
|
|
3771
4692
|
*
|
|
3772
4693
|
* Returns all pending (not consumed, not expired) team invites for the given team. Accepts a FaableQL `query` parameter on the `email` field.
|
|
4694
|
+
*
|
|
4695
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4696
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4697
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4698
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4699
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4700
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4701
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4702
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3773
4703
|
*/
|
|
3774
4704
|
teamListInvites(team_id: string, params?: OpQuery<"team/listInvites">): Promise<{
|
|
3775
4705
|
data: {
|
|
@@ -3796,6 +4726,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3796
4726
|
* List Team Members
|
|
3797
4727
|
*
|
|
3798
4728
|
* List all Users that belong to the given Team in the current Account. Supports `?expand=user,team,roles` to inline referenced rows.
|
|
4729
|
+
*
|
|
4730
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4731
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4732
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4733
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4734
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4735
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4736
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4737
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3799
4738
|
*/
|
|
3800
4739
|
teamListMembers(team_id: string, params?: Omit<OpQuery<"team/listMembers">, "cursor" | "next">): {
|
|
3801
4740
|
all: () => Promise<{
|
|
@@ -3844,6 +4783,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3844
4783
|
* Revoke a pending team invite
|
|
3845
4784
|
*
|
|
3846
4785
|
* Marks a pending team invite as consumed so it can no longer be accepted. Returns 400 if the invite is already consumed and 404 if it does not exist or belongs to a different team.
|
|
4786
|
+
*
|
|
4787
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4788
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4789
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4790
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4791
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4792
|
+
* @throws {FaableApiError} `invite_not_found` (404) — No invite with that id in this account.
|
|
4793
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4794
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4795
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3847
4796
|
*/
|
|
3848
4797
|
teamRevokeInvite(team_id: string, ticket_id: string): Promise<{
|
|
3849
4798
|
status: "revoked";
|
|
@@ -3852,6 +4801,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3852
4801
|
* `POST /team/{team_id}` — operationId: `team/update`
|
|
3853
4802
|
*
|
|
3854
4803
|
* Update Team
|
|
4804
|
+
*
|
|
4805
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4806
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4807
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4808
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4809
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4810
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4811
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4812
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4813
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4814
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4815
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3855
4816
|
*/
|
|
3856
4817
|
teamUpdate(team_id: string, data: OpBody<"team/update">): Promise<{
|
|
3857
4818
|
id: string;
|
|
@@ -3870,6 +4831,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3870
4831
|
* `POST /teammember` — operationId: `teammember/create`
|
|
3871
4832
|
*
|
|
3872
4833
|
* Create Teammember
|
|
4834
|
+
*
|
|
4835
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4836
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4837
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4838
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4839
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4840
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4841
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4842
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4843
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3873
4844
|
*/
|
|
3874
4845
|
teammemberCreate(data: OpBody<"teammember/create">): Promise<{
|
|
3875
4846
|
id: string;
|
|
@@ -3887,6 +4858,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3887
4858
|
* `DELETE /teammember/{teammember_id}` — operationId: `teammember/delete`
|
|
3888
4859
|
*
|
|
3889
4860
|
* Delete Teammember
|
|
4861
|
+
*
|
|
4862
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4863
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4864
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4865
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4866
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4867
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4868
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4869
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4870
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4871
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3890
4872
|
*/
|
|
3891
4873
|
teammemberDelete(teammember_id: string): Promise<{
|
|
3892
4874
|
id: string;
|
|
@@ -3904,6 +4886,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3904
4886
|
* `GET /teammember/{teammember_id}` — operationId: `teammember/get`
|
|
3905
4887
|
*
|
|
3906
4888
|
* Get Teammember
|
|
4889
|
+
*
|
|
4890
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
4891
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4892
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4893
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4894
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4895
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4896
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4897
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
4898
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4899
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4900
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3907
4901
|
*/
|
|
3908
4902
|
teammemberGet(teammember_id: string, params?: OpQuery<"teammember/get">): Promise<{
|
|
3909
4903
|
id: string;
|
|
@@ -3921,6 +4915,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3921
4915
|
* `GET /teammember` — operationId: `teammember/list`
|
|
3922
4916
|
*
|
|
3923
4917
|
* List Teammembers
|
|
4918
|
+
*
|
|
4919
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
4920
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
4921
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
4922
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4923
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4924
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4925
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4926
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4927
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4928
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4929
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3924
4930
|
*/
|
|
3925
4931
|
teammemberList(params?: Omit<OpQuery<"teammember/list">, "cursor" | "next">): {
|
|
3926
4932
|
all: () => Promise<{
|
|
@@ -3967,6 +4973,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3967
4973
|
* `POST /user` — operationId: `user/create`
|
|
3968
4974
|
*
|
|
3969
4975
|
* Create User
|
|
4976
|
+
*
|
|
4977
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
4978
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
4979
|
+
* @throws {FaableApiError} `invalid_phone` (400) — The phone number is not E.164 and could not be resolved with the account default country. Include the country code.
|
|
4980
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
4981
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
4982
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
4983
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
4984
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
4985
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
4986
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
3970
4987
|
*/
|
|
3971
4988
|
userCreate(data: OpBody<"user/create">): Promise<{
|
|
3972
4989
|
id: string;
|
|
@@ -3978,7 +4995,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3978
4995
|
nickname?: string | null | undefined;
|
|
3979
4996
|
email?: string | null | undefined;
|
|
3980
4997
|
email_verified: boolean;
|
|
3981
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
4998
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
3982
4999
|
email_verified_at?: string | null | undefined;
|
|
3983
5000
|
email_change_locked_at?: string | null | undefined;
|
|
3984
5001
|
email_bounced_at?: string | null | undefined;
|
|
@@ -3989,7 +5006,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
3989
5006
|
phone?: string | null | undefined;
|
|
3990
5007
|
phone_e164?: boolean | undefined;
|
|
3991
5008
|
phone_verified: boolean;
|
|
3992
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5009
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
3993
5010
|
phone_verified_at?: string | null | undefined;
|
|
3994
5011
|
country_iso?: string | null | undefined;
|
|
3995
5012
|
birth_date?: string | null | undefined;
|
|
@@ -4031,6 +5048,17 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4031
5048
|
* `DELETE /user/{user_id}` — operationId: `user/delete`
|
|
4032
5049
|
*
|
|
4033
5050
|
* Delete User
|
|
5051
|
+
*
|
|
5052
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
5053
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5054
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5055
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5056
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5057
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5058
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
5059
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5060
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5061
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4034
5062
|
*/
|
|
4035
5063
|
userDelete(user_id: string): Promise<{
|
|
4036
5064
|
id: string;
|
|
@@ -4042,7 +5070,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4042
5070
|
nickname?: string | null | undefined;
|
|
4043
5071
|
email?: string | null | undefined;
|
|
4044
5072
|
email_verified: boolean;
|
|
4045
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5073
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4046
5074
|
email_verified_at?: string | null | undefined;
|
|
4047
5075
|
email_change_locked_at?: string | null | undefined;
|
|
4048
5076
|
email_bounced_at?: string | null | undefined;
|
|
@@ -4053,7 +5081,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4053
5081
|
phone?: string | null | undefined;
|
|
4054
5082
|
phone_e164?: boolean | undefined;
|
|
4055
5083
|
phone_verified: boolean;
|
|
4056
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5084
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4057
5085
|
phone_verified_at?: string | null | undefined;
|
|
4058
5086
|
country_iso?: string | null | undefined;
|
|
4059
5087
|
birth_date?: string | null | undefined;
|
|
@@ -4095,6 +5123,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4095
5123
|
* `GET /user/{user_id}` — operationId: `user/get`
|
|
4096
5124
|
*
|
|
4097
5125
|
* Get User
|
|
5126
|
+
*
|
|
5127
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
5128
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
5129
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5130
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5131
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5132
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5133
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5134
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
5135
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5136
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5137
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4098
5138
|
*/
|
|
4099
5139
|
userGet(user_id: string): Promise<{
|
|
4100
5140
|
id: string;
|
|
@@ -4106,7 +5146,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4106
5146
|
nickname?: string | null | undefined;
|
|
4107
5147
|
email?: string | null | undefined;
|
|
4108
5148
|
email_verified: boolean;
|
|
4109
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5149
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4110
5150
|
email_verified_at?: string | null | undefined;
|
|
4111
5151
|
email_change_locked_at?: string | null | undefined;
|
|
4112
5152
|
email_bounced_at?: string | null | undefined;
|
|
@@ -4117,7 +5157,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4117
5157
|
phone?: string | null | undefined;
|
|
4118
5158
|
phone_e164?: boolean | undefined;
|
|
4119
5159
|
phone_verified: boolean;
|
|
4120
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5160
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4121
5161
|
phone_verified_at?: string | null | undefined;
|
|
4122
5162
|
country_iso?: string | null | undefined;
|
|
4123
5163
|
birth_date?: string | null | undefined;
|
|
@@ -4159,6 +5199,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4159
5199
|
* `GET /user` — operationId: `user/list`
|
|
4160
5200
|
*
|
|
4161
5201
|
* List Users
|
|
5202
|
+
*
|
|
5203
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
5204
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
5205
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
5206
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5207
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5208
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5209
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5210
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5211
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5212
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5213
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4162
5214
|
*/
|
|
4163
5215
|
userList(params?: Omit<OpQuery<"user/list">, "cursor" | "next">): {
|
|
4164
5216
|
all: () => Promise<{
|
|
@@ -4171,7 +5223,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4171
5223
|
nickname?: string | null | undefined;
|
|
4172
5224
|
email?: string | null | undefined;
|
|
4173
5225
|
email_verified: boolean;
|
|
4174
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5226
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4175
5227
|
email_verified_at?: string | null | undefined;
|
|
4176
5228
|
email_change_locked_at?: string | null | undefined;
|
|
4177
5229
|
email_bounced_at?: string | null | undefined;
|
|
@@ -4182,7 +5234,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4182
5234
|
phone?: string | null | undefined;
|
|
4183
5235
|
phone_e164?: boolean | undefined;
|
|
4184
5236
|
phone_verified: boolean;
|
|
4185
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5237
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4186
5238
|
phone_verified_at?: string | null | undefined;
|
|
4187
5239
|
country_iso?: string | null | undefined;
|
|
4188
5240
|
birth_date?: string | null | undefined;
|
|
@@ -4230,7 +5282,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4230
5282
|
nickname?: string | null | undefined;
|
|
4231
5283
|
email?: string | null | undefined;
|
|
4232
5284
|
email_verified: boolean;
|
|
4233
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5285
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4234
5286
|
email_verified_at?: string | null | undefined;
|
|
4235
5287
|
email_change_locked_at?: string | null | undefined;
|
|
4236
5288
|
email_bounced_at?: string | null | undefined;
|
|
@@ -4241,7 +5293,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4241
5293
|
phone?: string | null | undefined;
|
|
4242
5294
|
phone_e164?: boolean | undefined;
|
|
4243
5295
|
phone_verified: boolean;
|
|
4244
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5296
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4245
5297
|
phone_verified_at?: string | null | undefined;
|
|
4246
5298
|
country_iso?: string | null | undefined;
|
|
4247
5299
|
birth_date?: string | null | undefined;
|
|
@@ -4292,7 +5344,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4292
5344
|
nickname?: string | null | undefined;
|
|
4293
5345
|
email?: string | null | undefined;
|
|
4294
5346
|
email_verified: boolean;
|
|
4295
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5347
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4296
5348
|
email_verified_at?: string | null | undefined;
|
|
4297
5349
|
email_change_locked_at?: string | null | undefined;
|
|
4298
5350
|
email_bounced_at?: string | null | undefined;
|
|
@@ -4303,7 +5355,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4303
5355
|
phone?: string | null | undefined;
|
|
4304
5356
|
phone_e164?: boolean | undefined;
|
|
4305
5357
|
phone_verified: boolean;
|
|
4306
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5358
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4307
5359
|
phone_verified_at?: string | null | undefined;
|
|
4308
5360
|
country_iso?: string | null | undefined;
|
|
4309
5361
|
birth_date?: string | null | undefined;
|
|
@@ -4348,6 +5400,15 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4348
5400
|
* List the tickets issued for a user
|
|
4349
5401
|
*
|
|
4350
5402
|
* Returns the password-reset / verification / invitation tickets issued for this user, newest first, each with its status and — while it is still usable — the link that was emailed. Intended for handing a recovery link over by another channel when the email does not reach the person. Requires `update:credentials`: the link grants the same account access that setting a password does, and each reveal is recorded in the audit log.
|
|
5403
|
+
*
|
|
5404
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5405
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5406
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5407
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5408
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5409
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5410
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5411
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4351
5412
|
*/
|
|
4352
5413
|
userListTickets(user_id: string): Promise<{
|
|
4353
5414
|
results: {
|
|
@@ -4368,6 +5429,18 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4368
5429
|
* Send a password setup / reset email to the user
|
|
4369
5430
|
*
|
|
4370
5431
|
* Ensures the user has a database credential (provisioning a password-less one when missing, e.g. for users created via the management API) and creates a `changepassword` ticket, sending the standard password reset email. The link lands on the tenant's auth domain. Idempotent on the credential; each call emits a fresh ticket.
|
|
5432
|
+
*
|
|
5433
|
+
* @throws {FaableApiError} `invalid_client` (400) — The `client_id` in the request does not name a client of this account.
|
|
5434
|
+
* @throws {FaableApiError} `invalid_connection` (400) — The connection does not exist, is disabled, or is not of the type this flow needs.
|
|
5435
|
+
* @throws {FaableApiError} `user_has_no_email` (400) — The operation needs an email but the user has none.
|
|
5436
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5437
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5438
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5439
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5440
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5441
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5442
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5443
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4371
5444
|
*/
|
|
4372
5445
|
userPasswordSetup(user_id: string, data: OpBody<"user/passwordSetup">): Promise<{
|
|
4373
5446
|
status: "sent";
|
|
@@ -4381,6 +5454,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4381
5454
|
* Revoke a ticket issued for a user
|
|
4382
5455
|
*
|
|
4383
5456
|
* Marks the ticket as consumed so its link stops working immediately. The counterpart of listing links: once a link has been copied out of the dashboard it can end up in the wrong chat window, and the TTL alone is too slow an answer.
|
|
5457
|
+
*
|
|
5458
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5459
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5460
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5461
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5462
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5463
|
+
* @throws {FaableApiError} `ticket_not_found` (404) — No ticket with that id belongs to this user.
|
|
5464
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5465
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5466
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4384
5467
|
*/
|
|
4385
5468
|
userRevokeTicket(user_id: string, ticket_id: string): Promise<{
|
|
4386
5469
|
status: "revoked" | "already_used";
|
|
@@ -4390,6 +5473,19 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4390
5473
|
* `POST /user/{user_id}` — operationId: `user/update`
|
|
4391
5474
|
*
|
|
4392
5475
|
* Update User
|
|
5476
|
+
*
|
|
5477
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
5478
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
5479
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
5480
|
+
* @throws {FaableApiError} `invalid_phone` (400) — The phone number is not E.164 and could not be resolved with the account default country. Include the country code.
|
|
5481
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
5482
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
5483
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
5484
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
5485
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
5486
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
5487
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
5488
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
4393
5489
|
*/
|
|
4394
5490
|
userUpdate(user_id: string, data: OpBody<"user/update">): Promise<{
|
|
4395
5491
|
id: string;
|
|
@@ -4401,7 +5497,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4401
5497
|
nickname?: string | null | undefined;
|
|
4402
5498
|
email?: string | null | undefined;
|
|
4403
5499
|
email_verified: boolean;
|
|
4404
|
-
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5500
|
+
email_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4405
5501
|
email_verified_at?: string | null | undefined;
|
|
4406
5502
|
email_change_locked_at?: string | null | undefined;
|
|
4407
5503
|
email_bounced_at?: string | null | undefined;
|
|
@@ -4412,7 +5508,7 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
4412
5508
|
phone?: string | null | undefined;
|
|
4413
5509
|
phone_e164?: boolean | undefined;
|
|
4414
5510
|
phone_verified: boolean;
|
|
4415
|
-
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | null | undefined;
|
|
5511
|
+
phone_verified_method?: "manual" | "verification_flow" | "passwordless_otp" | "team_invite" | "email_change" | "federated" | "sms_otp" | "password_reset" | null | undefined;
|
|
4416
5512
|
phone_verified_at?: string | null | undefined;
|
|
4417
5513
|
country_iso?: string | null | undefined;
|
|
4418
5514
|
birth_date?: string | null | undefined;
|