@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
|
@@ -15,6 +15,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
15
15
|
* Create an Account
|
|
16
16
|
*
|
|
17
17
|
* Creates a new Auth Account. The slug is derived from the name and used to build the default `*.auth.faable.link` domain.
|
|
18
|
+
*
|
|
19
|
+
* @throws {FaableApiError} `team_required` (400) — An Auth Account must belong to a project (team).
|
|
20
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
21
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
22
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
23
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
24
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
25
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
26
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
27
|
+
* @throws {FaableApiError} `account_limit_reached` (409) — The project already has the maximum number of Auth Accounts.
|
|
28
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
29
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
18
30
|
*/
|
|
19
31
|
accountCreate(data) {
|
|
20
32
|
return this.fetcher.post(`/account`, data);
|
|
@@ -25,6 +37,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
25
37
|
* Get current Account
|
|
26
38
|
*
|
|
27
39
|
* Returns the Account resolved from request context (header, hostname, or team id). Use `expand` to populate nested references.
|
|
40
|
+
*
|
|
41
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
42
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
43
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
44
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
45
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
46
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
47
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
48
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
28
49
|
*/
|
|
29
50
|
accountCurrent(params) {
|
|
30
51
|
return this.fetcher.request({ method: "GET", url: `/account/current`, params });
|
|
@@ -35,6 +56,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
35
56
|
* Delete an Account
|
|
36
57
|
*
|
|
37
58
|
* Permanently removes an Account and its associated data. This action cannot be undone.
|
|
59
|
+
*
|
|
60
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
61
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
62
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
63
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
64
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
65
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
66
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
67
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
68
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
69
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
38
70
|
*/
|
|
39
71
|
accountDelete(account_id) {
|
|
40
72
|
requireId("account_id", account_id);
|
|
@@ -46,6 +78,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
46
78
|
* Get an Account
|
|
47
79
|
*
|
|
48
80
|
* Fetch a single Account by its id. Use `expand` to populate id-only fields (e.g. `default_connection`) inline.
|
|
81
|
+
*
|
|
82
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
83
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
84
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
85
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
86
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
87
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
88
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
89
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
90
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
91
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
92
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
49
93
|
*/
|
|
50
94
|
accountGet(account_id, params) {
|
|
51
95
|
requireId("account_id", account_id);
|
|
@@ -57,6 +101,14 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
57
101
|
* Get Account signing keys info
|
|
58
102
|
*
|
|
59
103
|
* 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.
|
|
104
|
+
*
|
|
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.
|
|
60
112
|
*/
|
|
61
113
|
accountGetKeys() {
|
|
62
114
|
return this.fetcher.get(`/account/keys`);
|
|
@@ -67,6 +119,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
67
119
|
* List Accounts
|
|
68
120
|
*
|
|
69
121
|
* List Accounts owned by the requesting project/team. Supports cursor pagination and `expand`.
|
|
122
|
+
*
|
|
123
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
124
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
125
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
126
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
127
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
128
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
129
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
130
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
131
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
132
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
133
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
70
134
|
*/
|
|
71
135
|
accountList(params) {
|
|
72
136
|
return this.paginator({ url: `/account`, params });
|
|
@@ -77,6 +141,14 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
77
141
|
* Recovery channel capabilities for this tenant
|
|
78
142
|
*
|
|
79
143
|
* 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.
|
|
144
|
+
*
|
|
145
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
146
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
147
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
148
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
149
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
150
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
151
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
80
152
|
*/
|
|
81
153
|
accountRecoveryChannelsCapabilities() {
|
|
82
154
|
return this.fetcher.get(`/recovery-channels/capabilities`);
|
|
@@ -87,6 +159,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
87
159
|
* Rotate Account signing keys
|
|
88
160
|
*
|
|
89
161
|
* 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`.
|
|
162
|
+
*
|
|
163
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
164
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
165
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
166
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
167
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
168
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
169
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
170
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
90
171
|
*/
|
|
91
172
|
accountRotateKeys(data) {
|
|
92
173
|
return this.fetcher.post(`/account/keys/rotate`, data);
|
|
@@ -97,6 +178,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
97
178
|
* Library health for this account
|
|
98
179
|
*
|
|
99
180
|
* 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.
|
|
181
|
+
*
|
|
182
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
183
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
184
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
185
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
186
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
187
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
188
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
189
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
100
190
|
*/
|
|
101
191
|
accountSdkHealth(account_id) {
|
|
102
192
|
requireId("account_id", account_id);
|
|
@@ -108,6 +198,19 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
108
198
|
* Update an Account
|
|
109
199
|
*
|
|
110
200
|
* Update the Account configuration such as branding (logo and icon URLs).
|
|
201
|
+
*
|
|
202
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
203
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
204
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
205
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
206
|
+
* @throws {FaableApiError} `plan_required` (402) — The setting requires a higher plan. `message` says which.
|
|
207
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
208
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
209
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
210
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
211
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
212
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
213
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
111
214
|
*/
|
|
112
215
|
accountUpdate(account_id, data) {
|
|
113
216
|
requireId("account_id", account_id);
|
|
@@ -117,6 +220,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
117
220
|
* `POST /action` — operationId: `action/create`
|
|
118
221
|
*
|
|
119
222
|
* Create Action
|
|
223
|
+
*
|
|
224
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
225
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
226
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
227
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
228
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
229
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
230
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
231
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
232
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
120
233
|
*/
|
|
121
234
|
actionCreate(data) {
|
|
122
235
|
return this.fetcher.post(`/action`, data);
|
|
@@ -125,6 +238,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
125
238
|
* `DELETE /action/{action_id}` — operationId: `action/delete`
|
|
126
239
|
*
|
|
127
240
|
* Delete Action
|
|
241
|
+
*
|
|
242
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
243
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
244
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
245
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
246
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
247
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
248
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
249
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
250
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
251
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
128
252
|
*/
|
|
129
253
|
actionDelete(action_id) {
|
|
130
254
|
requireId("action_id", action_id);
|
|
@@ -134,6 +258,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
134
258
|
* `GET /action/{action_id}` — operationId: `action/get`
|
|
135
259
|
*
|
|
136
260
|
* Get Action
|
|
261
|
+
*
|
|
262
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
263
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
264
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
265
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
266
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
267
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
268
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
269
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
270
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
271
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
272
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
137
273
|
*/
|
|
138
274
|
actionGet(action_id) {
|
|
139
275
|
requireId("action_id", action_id);
|
|
@@ -143,6 +279,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
143
279
|
* `GET /action` — operationId: `action/list`
|
|
144
280
|
*
|
|
145
281
|
* List Actions
|
|
282
|
+
*
|
|
283
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
284
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
285
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
286
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
287
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
288
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
289
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
290
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
291
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
292
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
293
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
146
294
|
*/
|
|
147
295
|
actionList(params) {
|
|
148
296
|
return this.paginator({ url: `/action`, params });
|
|
@@ -151,6 +299,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
151
299
|
* `POST /action/{action_id}` — operationId: `action/update`
|
|
152
300
|
*
|
|
153
301
|
* Update Action
|
|
302
|
+
*
|
|
303
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
304
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
305
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
306
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
307
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
308
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
309
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
310
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
311
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
312
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
313
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
154
314
|
*/
|
|
155
315
|
actionUpdate(action_id, data) {
|
|
156
316
|
requireId("action_id", action_id);
|
|
@@ -160,6 +320,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
160
320
|
* `POST /api` — operationId: `api/create`
|
|
161
321
|
*
|
|
162
322
|
* Create Api
|
|
323
|
+
*
|
|
324
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
325
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
326
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
327
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
328
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
329
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
330
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
331
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
332
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
163
333
|
*/
|
|
164
334
|
apiCreate(data) {
|
|
165
335
|
return this.fetcher.post(`/api`, data);
|
|
@@ -168,6 +338,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
168
338
|
* `DELETE /api/{api_id}` — operationId: `api/delete`
|
|
169
339
|
*
|
|
170
340
|
* Delete Api
|
|
341
|
+
*
|
|
342
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
343
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
344
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
345
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
346
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
347
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
348
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
349
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
350
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
351
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
171
352
|
*/
|
|
172
353
|
apiDelete(api_id) {
|
|
173
354
|
requireId("api_id", api_id);
|
|
@@ -177,6 +358,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
177
358
|
* `GET /api/{api_id}` — operationId: `api/get`
|
|
178
359
|
*
|
|
179
360
|
* Get Api
|
|
361
|
+
*
|
|
362
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
363
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
364
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
365
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
366
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
367
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
368
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
369
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
370
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
371
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
372
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
180
373
|
*/
|
|
181
374
|
apiGet(api_id) {
|
|
182
375
|
requireId("api_id", api_id);
|
|
@@ -186,6 +379,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
186
379
|
* `GET /api` — operationId: `api/list`
|
|
187
380
|
*
|
|
188
381
|
* List Apis
|
|
382
|
+
*
|
|
383
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
384
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
385
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
386
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
387
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
388
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
389
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
390
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
391
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
392
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
393
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
189
394
|
*/
|
|
190
395
|
apiList(params) {
|
|
191
396
|
return this.paginator({ url: `/api`, params });
|
|
@@ -194,6 +399,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
194
399
|
* `POST /api/{api_id}` — operationId: `api/update`
|
|
195
400
|
*
|
|
196
401
|
* Update Api
|
|
402
|
+
*
|
|
403
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
404
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
405
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
406
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
407
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
408
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
409
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
410
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
411
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
412
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
413
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
197
414
|
*/
|
|
198
415
|
apiUpdate(api_id, data) {
|
|
199
416
|
requireId("api_id", api_id);
|
|
@@ -203,6 +420,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
203
420
|
* `POST /client` — operationId: `client/create`
|
|
204
421
|
*
|
|
205
422
|
* Create Client
|
|
423
|
+
*
|
|
424
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
425
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
426
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
427
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
428
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
429
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
430
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
431
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
432
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
206
433
|
*/
|
|
207
434
|
clientCreate(data) {
|
|
208
435
|
return this.fetcher.post(`/client`, data);
|
|
@@ -211,6 +438,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
211
438
|
* `DELETE /client/{client_id}` — operationId: `client/delete`
|
|
212
439
|
*
|
|
213
440
|
* Delete Client
|
|
441
|
+
*
|
|
442
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
443
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
444
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
445
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
446
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
447
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
448
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
449
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
450
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
451
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
214
452
|
*/
|
|
215
453
|
clientDelete(client_id) {
|
|
216
454
|
requireId("client_id", client_id);
|
|
@@ -220,6 +458,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
220
458
|
* `GET /client/{client_id}` — operationId: `client/get`
|
|
221
459
|
*
|
|
222
460
|
* Get Client
|
|
461
|
+
*
|
|
462
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
463
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
464
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
465
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
466
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
467
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
468
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
469
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
470
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
471
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
472
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
223
473
|
*/
|
|
224
474
|
clientGet(client_id) {
|
|
225
475
|
requireId("client_id", client_id);
|
|
@@ -229,6 +479,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
229
479
|
* `GET /client` — operationId: `client/list`
|
|
230
480
|
*
|
|
231
481
|
* List Clients
|
|
482
|
+
*
|
|
483
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
484
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
485
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
486
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
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.
|
|
232
494
|
*/
|
|
233
495
|
clientList(params) {
|
|
234
496
|
return this.paginator({ url: `/client`, params });
|
|
@@ -239,6 +501,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
239
501
|
* Rotate a Client's secret
|
|
240
502
|
*
|
|
241
503
|
* 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.
|
|
504
|
+
*
|
|
505
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
506
|
+
* @throws {FaableApiError} `client_mismatch` (401) — The client belongs to a different account.
|
|
507
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
508
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
509
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
510
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
511
|
+
* @throws {FaableApiError} `client_not_found` (404) — No client with that `client_id`.
|
|
512
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
513
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
514
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
242
515
|
*/
|
|
243
516
|
clientRotateSecret(client_id) {
|
|
244
517
|
requireId("client_id", client_id);
|
|
@@ -248,6 +521,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
248
521
|
* `POST /client/{client_id}` — operationId: `client/update`
|
|
249
522
|
*
|
|
250
523
|
* Update Client
|
|
524
|
+
*
|
|
525
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
526
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
527
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
528
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
529
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
530
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
531
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
532
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
533
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
534
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
535
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
251
536
|
*/
|
|
252
537
|
clientUpdate(client_id, data) {
|
|
253
538
|
requireId("client_id", client_id);
|
|
@@ -257,6 +542,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
257
542
|
* `POST /connection` — operationId: `connection/create`
|
|
258
543
|
*
|
|
259
544
|
* Create Connection
|
|
545
|
+
*
|
|
546
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
547
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
548
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
549
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
550
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
551
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
552
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
553
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
554
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
260
555
|
*/
|
|
261
556
|
connectionCreate(data) {
|
|
262
557
|
return this.fetcher.post(`/connection`, data);
|
|
@@ -265,6 +560,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
265
560
|
* `DELETE /connection/{connection_id}` — operationId: `connection/delete`
|
|
266
561
|
*
|
|
267
562
|
* Delete Connection
|
|
563
|
+
*
|
|
564
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
565
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
566
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
567
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
568
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
569
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
570
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
571
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
572
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
573
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
268
574
|
*/
|
|
269
575
|
connectionDelete(connection_id) {
|
|
270
576
|
requireId("connection_id", connection_id);
|
|
@@ -274,6 +580,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
274
580
|
* `GET /connection/{connection_id}` — operationId: `connection/get`
|
|
275
581
|
*
|
|
276
582
|
* Get Connection
|
|
583
|
+
*
|
|
584
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
585
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
586
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
587
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
588
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
589
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
590
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
591
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
592
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
593
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
594
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
277
595
|
*/
|
|
278
596
|
connectionGet(connection_id) {
|
|
279
597
|
requireId("connection_id", connection_id);
|
|
@@ -283,6 +601,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
283
601
|
* `GET /connection` — operationId: `connection/list`
|
|
284
602
|
*
|
|
285
603
|
* List Connections
|
|
604
|
+
*
|
|
605
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
606
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
607
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
608
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
609
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
610
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
611
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
612
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
613
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
614
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
615
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
286
616
|
*/
|
|
287
617
|
connectionList(params) {
|
|
288
618
|
return this.paginator({ url: `/connection`, params });
|
|
@@ -291,6 +621,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
291
621
|
* `POST /connection/{connection_id}` — operationId: `connection/update`
|
|
292
622
|
*
|
|
293
623
|
* Update Connection
|
|
624
|
+
*
|
|
625
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
626
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
627
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
628
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
629
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
630
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
631
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
632
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
633
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
634
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
635
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
294
636
|
*/
|
|
295
637
|
connectionUpdate(connection_id, data) {
|
|
296
638
|
requireId("connection_id", connection_id);
|
|
@@ -300,6 +642,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
300
642
|
* `POST /credentials` — operationId: `credentials/create`
|
|
301
643
|
*
|
|
302
644
|
* Create Credentials
|
|
645
|
+
*
|
|
646
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
647
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
648
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
649
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
650
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
651
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
652
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
653
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
654
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
303
655
|
*/
|
|
304
656
|
credentialsCreate(data) {
|
|
305
657
|
return this.fetcher.post(`/credentials`, data);
|
|
@@ -308,6 +660,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
308
660
|
* `DELETE /credentials/{credentials_id}` — operationId: `credentials/delete`
|
|
309
661
|
*
|
|
310
662
|
* Delete Credentials
|
|
663
|
+
*
|
|
664
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
665
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
666
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
667
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
668
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
669
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
670
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
671
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
672
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
673
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
311
674
|
*/
|
|
312
675
|
credentialsDelete(credentials_id) {
|
|
313
676
|
requireId("credentials_id", credentials_id);
|
|
@@ -317,6 +680,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
317
680
|
* `GET /credentials/{credentials_id}` — operationId: `credentials/get`
|
|
318
681
|
*
|
|
319
682
|
* Get Credentials
|
|
683
|
+
*
|
|
684
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
685
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
686
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
687
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
688
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
689
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
690
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
691
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
692
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
693
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
694
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
320
695
|
*/
|
|
321
696
|
credentialsGet(credentials_id, params) {
|
|
322
697
|
requireId("credentials_id", credentials_id);
|
|
@@ -326,6 +701,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
326
701
|
* `GET /credentials` — operationId: `credentials/list`
|
|
327
702
|
*
|
|
328
703
|
* List Credentialss
|
|
704
|
+
*
|
|
705
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
706
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
707
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
708
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
709
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
710
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
711
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
712
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
713
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
714
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
715
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
329
716
|
*/
|
|
330
717
|
credentialsList(params) {
|
|
331
718
|
return this.paginator({ url: `/credentials`, params });
|
|
@@ -336,6 +723,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
336
723
|
* Set a credential's password
|
|
337
724
|
*
|
|
338
725
|
* 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.
|
|
726
|
+
*
|
|
727
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
728
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
729
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
730
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
731
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
732
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
733
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
734
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
339
735
|
*/
|
|
340
736
|
credentialsSetPassword(credentials_id, data) {
|
|
341
737
|
requireId("credentials_id", credentials_id);
|
|
@@ -345,6 +741,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
345
741
|
* `POST /credentials/{credentials_id}` — operationId: `credentials/update`
|
|
346
742
|
*
|
|
347
743
|
* Update Credentials
|
|
744
|
+
*
|
|
745
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
746
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
747
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
748
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
749
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
750
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
751
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
752
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
753
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
754
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
755
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
348
756
|
*/
|
|
349
757
|
credentialsUpdate(credentials_id, data) {
|
|
350
758
|
requireId("credentials_id", credentials_id);
|
|
@@ -354,6 +762,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
354
762
|
* `POST /customdomain` — operationId: `customdomain/create`
|
|
355
763
|
*
|
|
356
764
|
* Create Customdomain
|
|
765
|
+
*
|
|
766
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
767
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
768
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
769
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
770
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
771
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
772
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
773
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
774
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
357
775
|
*/
|
|
358
776
|
customdomainCreate(data) {
|
|
359
777
|
return this.fetcher.post(`/customdomain`, data);
|
|
@@ -362,6 +780,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
362
780
|
* `DELETE /customdomain/{customdomain_id}` — operationId: `customdomain/delete`
|
|
363
781
|
*
|
|
364
782
|
* Delete Customdomain
|
|
783
|
+
*
|
|
784
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
785
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
786
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
787
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
788
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
789
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
790
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
791
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
792
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
793
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
365
794
|
*/
|
|
366
795
|
customdomainDelete(customdomain_id) {
|
|
367
796
|
requireId("customdomain_id", customdomain_id);
|
|
@@ -371,6 +800,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
371
800
|
* `GET /customdomain/{customdomain_id}` — operationId: `customdomain/get`
|
|
372
801
|
*
|
|
373
802
|
* Get Customdomain
|
|
803
|
+
*
|
|
804
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
805
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
806
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
807
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
808
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
809
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
810
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
811
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
812
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
813
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
814
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
374
815
|
*/
|
|
375
816
|
customdomainGet(customdomain_id) {
|
|
376
817
|
requireId("customdomain_id", customdomain_id);
|
|
@@ -380,6 +821,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
380
821
|
* `GET /customdomain` — operationId: `customdomain/list`
|
|
381
822
|
*
|
|
382
823
|
* List Customdomains
|
|
824
|
+
*
|
|
825
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
826
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
827
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
828
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
829
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
830
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
831
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
832
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
833
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
834
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
835
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
383
836
|
*/
|
|
384
837
|
customdomainList(params) {
|
|
385
838
|
return this.paginator({ url: `/customdomain`, params });
|
|
@@ -390,6 +843,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
390
843
|
* Trigger a domain verification check now
|
|
391
844
|
*
|
|
392
845
|
* 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.
|
|
846
|
+
*
|
|
847
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
848
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
849
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
850
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
851
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
852
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
853
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
854
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
393
855
|
*/
|
|
394
856
|
customdomainRetry(customdomain_id) {
|
|
395
857
|
requireId("customdomain_id", customdomain_id);
|
|
@@ -399,6 +861,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
399
861
|
* `POST /identity` — operationId: `identity/create`
|
|
400
862
|
*
|
|
401
863
|
* Create Identity
|
|
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.
|
|
402
874
|
*/
|
|
403
875
|
identityCreate(data) {
|
|
404
876
|
return this.fetcher.post(`/identity`, data);
|
|
@@ -407,6 +879,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
407
879
|
* `DELETE /identity/{identity_id}` — operationId: `identity/delete`
|
|
408
880
|
*
|
|
409
881
|
* Delete Identity
|
|
882
|
+
*
|
|
883
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
884
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
885
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
886
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
887
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
888
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
889
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
890
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
891
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
892
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
410
893
|
*/
|
|
411
894
|
identityDelete(identity_id) {
|
|
412
895
|
requireId("identity_id", identity_id);
|
|
@@ -416,6 +899,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
416
899
|
* `GET /identity/{identity_id}` — operationId: `identity/get`
|
|
417
900
|
*
|
|
418
901
|
* Get Identity
|
|
902
|
+
*
|
|
903
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
904
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
905
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
906
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
907
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
908
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
909
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
910
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
911
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
912
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
913
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
419
914
|
*/
|
|
420
915
|
identityGet(identity_id, params) {
|
|
421
916
|
requireId("identity_id", identity_id);
|
|
@@ -427,6 +922,19 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
427
922
|
* Get a guaranteed-valid provider access_token
|
|
428
923
|
*
|
|
429
924
|
* 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).
|
|
925
|
+
*
|
|
926
|
+
* @throws {FaableApiError} `connection_misconfigured` (400) — The connection is missing settings needed to talk to its provider.
|
|
927
|
+
* @throws {FaableApiError} `no_provider_token` (400) — The identity holds no provider access token.
|
|
928
|
+
* @throws {FaableApiError} `no_refresh_token` (400) — The identity holds no provider refresh token, so it cannot be refreshed.
|
|
929
|
+
* @throws {FaableApiError} `provider_error` (400) — The upstream identity provider returned an error. `message` carries it.
|
|
930
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
931
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
932
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
933
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
934
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
935
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
936
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
937
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
430
938
|
*/
|
|
431
939
|
identityGetProviderToken(identity_id, params) {
|
|
432
940
|
requireId("identity_id", identity_id);
|
|
@@ -436,6 +944,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
436
944
|
* `GET /identity` — operationId: `identity/list`
|
|
437
945
|
*
|
|
438
946
|
* List Identitys
|
|
947
|
+
*
|
|
948
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
949
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
950
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
951
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
952
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
953
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
954
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
955
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
956
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
957
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
958
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
439
959
|
*/
|
|
440
960
|
identityList(params) {
|
|
441
961
|
return this.paginator({ url: `/identity`, params });
|
|
@@ -446,6 +966,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
446
966
|
* SMS sent per tenant in a month (platform)
|
|
447
967
|
*
|
|
448
968
|
* 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`.
|
|
969
|
+
*
|
|
970
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
971
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
972
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
973
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
974
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
975
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
976
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
977
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
449
978
|
*/
|
|
450
979
|
internalSmsUsage(params) {
|
|
451
980
|
return this.fetcher.request({ method: "GET", url: `/internal/usage/sms`, params });
|
|
@@ -454,6 +983,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
454
983
|
* `GET /log/{log_id}` — operationId: `log/get`
|
|
455
984
|
*
|
|
456
985
|
* Get Log
|
|
986
|
+
*
|
|
987
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
988
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
989
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
990
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
991
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
992
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
993
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
994
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
995
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
996
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
997
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
457
998
|
*/
|
|
458
999
|
logGet(log_id, params) {
|
|
459
1000
|
requireId("log_id", log_id);
|
|
@@ -463,6 +1004,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
463
1004
|
* `GET /log` — operationId: `log/list`
|
|
464
1005
|
*
|
|
465
1006
|
* List Logs
|
|
1007
|
+
*
|
|
1008
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1009
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1010
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1011
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1012
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1013
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1014
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1015
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1016
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1017
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1018
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
466
1019
|
*/
|
|
467
1020
|
logList(params) {
|
|
468
1021
|
return this.paginator({ url: `/log`, params });
|
|
@@ -471,6 +1024,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
471
1024
|
* `POST /loginflow` — operationId: `loginflow/create`
|
|
472
1025
|
*
|
|
473
1026
|
* Create Loginflow
|
|
1027
|
+
*
|
|
1028
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1029
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1030
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1031
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1032
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1033
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1034
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1035
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1036
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
474
1037
|
*/
|
|
475
1038
|
loginflowCreate(data) {
|
|
476
1039
|
return this.fetcher.post(`/loginflow`, data);
|
|
@@ -479,6 +1042,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
479
1042
|
* `DELETE /loginflow/{loginflow_id}` — operationId: `loginflow/delete`
|
|
480
1043
|
*
|
|
481
1044
|
* Delete Loginflow
|
|
1045
|
+
*
|
|
1046
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1047
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1048
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1049
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1050
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1051
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1052
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1053
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1054
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1055
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
482
1056
|
*/
|
|
483
1057
|
loginflowDelete(loginflow_id) {
|
|
484
1058
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -488,6 +1062,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
488
1062
|
* `GET /loginflow/{loginflow_id}` — operationId: `loginflow/get`
|
|
489
1063
|
*
|
|
490
1064
|
* Get Loginflow
|
|
1065
|
+
*
|
|
1066
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1067
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1068
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1069
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1070
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1071
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1072
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1073
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1074
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1075
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1076
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
491
1077
|
*/
|
|
492
1078
|
loginflowGet(loginflow_id) {
|
|
493
1079
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -497,6 +1083,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
497
1083
|
* `GET /loginflow` — operationId: `loginflow/list`
|
|
498
1084
|
*
|
|
499
1085
|
* List Loginflows
|
|
1086
|
+
*
|
|
1087
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1088
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1089
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1090
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1091
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1092
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1093
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1094
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1095
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1096
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1097
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
500
1098
|
*/
|
|
501
1099
|
loginflowList(params) {
|
|
502
1100
|
return this.paginator({ url: `/loginflow`, params });
|
|
@@ -507,6 +1105,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
507
1105
|
* Start a custom flow from what runs today
|
|
508
1106
|
*
|
|
509
1107
|
* 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.
|
|
1108
|
+
*
|
|
1109
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1110
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1111
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1112
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1113
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1114
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1115
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1116
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
510
1117
|
*/
|
|
511
1118
|
loginflowMaterialize(data) {
|
|
512
1119
|
return this.fetcher.post(`/loginflow/materialize`, data);
|
|
@@ -517,6 +1124,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
517
1124
|
* Try the draft on a real login, in your browser only
|
|
518
1125
|
*
|
|
519
1126
|
* 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.
|
|
1127
|
+
*
|
|
1128
|
+
* @throws {FaableApiError} `flow_not_found` (400) — The login flow does not exist in this account.
|
|
1129
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1130
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1131
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1132
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1133
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1134
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1135
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1136
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
520
1137
|
*/
|
|
521
1138
|
loginflowPreviewToken(loginflow_id) {
|
|
522
1139
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -528,6 +1145,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
528
1145
|
* Make the draft the graph logins run
|
|
529
1146
|
*
|
|
530
1147
|
* 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.
|
|
1148
|
+
*
|
|
1149
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1150
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1151
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1152
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1153
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1154
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1155
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1156
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
531
1157
|
*/
|
|
532
1158
|
loginflowPublish(loginflow_id, data) {
|
|
533
1159
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -539,6 +1165,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
539
1165
|
* The graph this account (or client) runs right now
|
|
540
1166
|
*
|
|
541
1167
|
* 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.
|
|
1168
|
+
*
|
|
1169
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1170
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1171
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1172
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1173
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1174
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1175
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1176
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
542
1177
|
*/
|
|
543
1178
|
loginflowResolved(params) {
|
|
544
1179
|
return this.fetcher.request({ method: "GET", url: `/loginflow/resolved`, params });
|
|
@@ -549,6 +1184,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
549
1184
|
* Run a previously published revision again
|
|
550
1185
|
*
|
|
551
1186
|
* Makes the named revision from `history` the published graph; the one being replaced moves to `history`. The draft is not touched.
|
|
1187
|
+
*
|
|
1188
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1189
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1190
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1191
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1192
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1193
|
+
* @throws {FaableApiError} `revision_not_found` (404) — The revision is not in the flow history.
|
|
1194
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1195
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1196
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
552
1197
|
*/
|
|
553
1198
|
loginflowRollback(loginflow_id, data) {
|
|
554
1199
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -558,6 +1203,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
558
1203
|
* `POST /loginflow/{loginflow_id}` — operationId: `loginflow/update`
|
|
559
1204
|
*
|
|
560
1205
|
* Update Loginflow
|
|
1206
|
+
*
|
|
1207
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1208
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1209
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1210
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1211
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1212
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1213
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1214
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1215
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1216
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1217
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
561
1218
|
*/
|
|
562
1219
|
loginflowUpdate(loginflow_id, data) {
|
|
563
1220
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -567,6 +1224,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
567
1224
|
* `POST /loginflow/{loginflow_id}/validate` — operationId: `loginflow/validate`
|
|
568
1225
|
*
|
|
569
1226
|
* Check a draft against the rules a publish enforces
|
|
1227
|
+
*
|
|
1228
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1229
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1230
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1231
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1232
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1233
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1234
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1235
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
570
1236
|
*/
|
|
571
1237
|
loginflowValidate(loginflow_id, data) {
|
|
572
1238
|
requireId("loginflow_id", loginflow_id);
|
|
@@ -576,6 +1242,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
576
1242
|
* `POST /notificationsubscription` — operationId: `notificationsubscription/create`
|
|
577
1243
|
*
|
|
578
1244
|
* Create Notificationsubscription
|
|
1245
|
+
*
|
|
1246
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1247
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1248
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1249
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1250
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1251
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1252
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1253
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1254
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
579
1255
|
*/
|
|
580
1256
|
notificationsubscriptionCreate(data) {
|
|
581
1257
|
return this.fetcher.post(`/notificationsubscription`, data);
|
|
@@ -584,6 +1260,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
584
1260
|
* `DELETE /notificationsubscription/{notificationsubscription_id}` — operationId: `notificationsubscription/delete`
|
|
585
1261
|
*
|
|
586
1262
|
* Delete Notificationsubscription
|
|
1263
|
+
*
|
|
1264
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1265
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1266
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1267
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1268
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1269
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1270
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1271
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1272
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1273
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
587
1274
|
*/
|
|
588
1275
|
notificationsubscriptionDelete(notificationsubscription_id) {
|
|
589
1276
|
requireId("notificationsubscription_id", notificationsubscription_id);
|
|
@@ -593,6 +1280,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
593
1280
|
* `GET /notificationsubscription/{notificationsubscription_id}` — operationId: `notificationsubscription/get`
|
|
594
1281
|
*
|
|
595
1282
|
* Get Notificationsubscription
|
|
1283
|
+
*
|
|
1284
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1285
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1286
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1287
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1288
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1289
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1290
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1291
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1292
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1293
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1294
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
596
1295
|
*/
|
|
597
1296
|
notificationsubscriptionGet(notificationsubscription_id) {
|
|
598
1297
|
requireId("notificationsubscription_id", notificationsubscription_id);
|
|
@@ -602,6 +1301,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
602
1301
|
* `GET /notificationsubscription` — operationId: `notificationsubscription/list`
|
|
603
1302
|
*
|
|
604
1303
|
* List Notificationsubscriptions
|
|
1304
|
+
*
|
|
1305
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1306
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1307
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1308
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1309
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1310
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1311
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1312
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1313
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1314
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1315
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
605
1316
|
*/
|
|
606
1317
|
notificationsubscriptionList(params) {
|
|
607
1318
|
return this.paginator({ url: `/notificationsubscription`, params });
|
|
@@ -610,6 +1321,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
610
1321
|
* `POST /notificationsubscription/{notificationsubscription_id}` — operationId: `notificationsubscription/update`
|
|
611
1322
|
*
|
|
612
1323
|
* Update Notificationsubscription
|
|
1324
|
+
*
|
|
1325
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1326
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1327
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1328
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1329
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1330
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1331
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1332
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1333
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1334
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1335
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
613
1336
|
*/
|
|
614
1337
|
notificationsubscriptionUpdate(notificationsubscription_id, data) {
|
|
615
1338
|
requireId("notificationsubscription_id", notificationsubscription_id);
|
|
@@ -619,6 +1342,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
619
1342
|
* `POST /role/{role_id}/users` — operationId: `role/assign_users`
|
|
620
1343
|
*
|
|
621
1344
|
* Assign Users to Role
|
|
1345
|
+
*
|
|
1346
|
+
* @throws {FaableApiError} `invalid_role` (400) — The role belongs to another account.
|
|
1347
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1348
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1349
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1350
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1351
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1352
|
+
* @throws {FaableApiError} `role_not_found` (404) — No role with that id in this account.
|
|
1353
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1354
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1355
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
622
1356
|
*/
|
|
623
1357
|
roleAssignUsers(role_id, data) {
|
|
624
1358
|
requireId("role_id", role_id);
|
|
@@ -628,6 +1362,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
628
1362
|
* `POST /role` — operationId: `role/create`
|
|
629
1363
|
*
|
|
630
1364
|
* Create Role
|
|
1365
|
+
*
|
|
1366
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1367
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1368
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1369
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1370
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1371
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1372
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1373
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1374
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
631
1375
|
*/
|
|
632
1376
|
roleCreate(data) {
|
|
633
1377
|
return this.fetcher.post(`/role`, data);
|
|
@@ -636,6 +1380,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
636
1380
|
* `DELETE /role/{role_id}` — operationId: `role/delete`
|
|
637
1381
|
*
|
|
638
1382
|
* Delete Role
|
|
1383
|
+
*
|
|
1384
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1385
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1386
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1387
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1388
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1389
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1390
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1391
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1392
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1393
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
639
1394
|
*/
|
|
640
1395
|
roleDelete(role_id) {
|
|
641
1396
|
requireId("role_id", role_id);
|
|
@@ -645,6 +1400,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
645
1400
|
* `GET /role/{role_id}` — operationId: `role/get`
|
|
646
1401
|
*
|
|
647
1402
|
* Get Role
|
|
1403
|
+
*
|
|
1404
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1405
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1406
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1407
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1408
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1409
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1410
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1411
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1412
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1413
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1414
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
648
1415
|
*/
|
|
649
1416
|
roleGet(role_id) {
|
|
650
1417
|
requireId("role_id", role_id);
|
|
@@ -654,6 +1421,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
654
1421
|
* `GET /role` — operationId: `role/list`
|
|
655
1422
|
*
|
|
656
1423
|
* List Roles
|
|
1424
|
+
*
|
|
1425
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1426
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1427
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1428
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1429
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1430
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1431
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1432
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1433
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1434
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1435
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
657
1436
|
*/
|
|
658
1437
|
roleList(params) {
|
|
659
1438
|
return this.paginator({ url: `/role`, params });
|
|
@@ -662,6 +1441,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
662
1441
|
* `POST /role/{role_id}` — operationId: `role/update`
|
|
663
1442
|
*
|
|
664
1443
|
* Update Role
|
|
1444
|
+
*
|
|
1445
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1446
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1447
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1448
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1449
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1450
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1451
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1452
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1453
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1454
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1455
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
665
1456
|
*/
|
|
666
1457
|
roleUpdate(role_id, data) {
|
|
667
1458
|
requireId("role_id", role_id);
|
|
@@ -671,6 +1462,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
671
1462
|
* `GET /role/{role_id}/users` — operationId: `role/users`
|
|
672
1463
|
*
|
|
673
1464
|
* List Users with Role
|
|
1465
|
+
*
|
|
1466
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1467
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1468
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1469
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1470
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1471
|
+
* @throws {FaableApiError} `role_not_found` (404) — No role with that id in this account.
|
|
1472
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1473
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1474
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
674
1475
|
*/
|
|
675
1476
|
roleUsers(role_id, params) {
|
|
676
1477
|
requireId("role_id", role_id);
|
|
@@ -680,6 +1481,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
680
1481
|
* `POST /rolemember` — operationId: `rolemember/create`
|
|
681
1482
|
*
|
|
682
1483
|
* Create Rolemember
|
|
1484
|
+
*
|
|
1485
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1486
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1487
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1488
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1489
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1490
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1491
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1492
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1493
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
683
1494
|
*/
|
|
684
1495
|
rolememberCreate(data) {
|
|
685
1496
|
return this.fetcher.post(`/rolemember`, data);
|
|
@@ -688,6 +1499,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
688
1499
|
* `DELETE /rolemember/{rolemember_id}` — operationId: `rolemember/delete`
|
|
689
1500
|
*
|
|
690
1501
|
* Delete Rolemember
|
|
1502
|
+
*
|
|
1503
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1504
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1505
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1506
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1507
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1508
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1509
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1510
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1511
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1512
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
691
1513
|
*/
|
|
692
1514
|
rolememberDelete(rolemember_id) {
|
|
693
1515
|
requireId("rolemember_id", rolemember_id);
|
|
@@ -697,6 +1519,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
697
1519
|
* `GET /rolemember/{rolemember_id}` — operationId: `rolemember/get`
|
|
698
1520
|
*
|
|
699
1521
|
* Get Rolemember
|
|
1522
|
+
*
|
|
1523
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1524
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1525
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1526
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1527
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1528
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1529
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1530
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1531
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1532
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1533
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
700
1534
|
*/
|
|
701
1535
|
rolememberGet(rolemember_id, params) {
|
|
702
1536
|
requireId("rolemember_id", rolemember_id);
|
|
@@ -706,6 +1540,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
706
1540
|
* `GET /rolemember` — operationId: `rolemember/list`
|
|
707
1541
|
*
|
|
708
1542
|
* List Rolemembers
|
|
1543
|
+
*
|
|
1544
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1545
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1546
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1547
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1548
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1549
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1550
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1551
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1552
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1553
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1554
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
709
1555
|
*/
|
|
710
1556
|
rolememberList(params) {
|
|
711
1557
|
return this.paginator({ url: `/rolemember`, params });
|
|
@@ -716,6 +1562,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
716
1562
|
* Add Users to a Team
|
|
717
1563
|
*
|
|
718
1564
|
* Adds one or more Users as members of the given Team. Returns the resulting TeamMember record.
|
|
1565
|
+
*
|
|
1566
|
+
* @throws {FaableApiError} `already_member` (400) — The user is already a member of the team.
|
|
1567
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1568
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1569
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1570
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1571
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1572
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1573
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1574
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
719
1575
|
*/
|
|
720
1576
|
teamAddMembers(team_id, data) {
|
|
721
1577
|
requireId("team_id", team_id);
|
|
@@ -727,6 +1583,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
727
1583
|
* Check User is member of a Team
|
|
728
1584
|
*
|
|
729
1585
|
* Returns the TeamMember record if the User belongs to the given Team, or 404 otherwise.
|
|
1586
|
+
*
|
|
1587
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1588
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1589
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1590
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1591
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1592
|
+
* @throws {FaableApiError} `not_a_member` (404) — The user is not a member of the team.
|
|
1593
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1594
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1595
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
730
1596
|
*/
|
|
731
1597
|
teamCheckMember(team_id, user_id, params) {
|
|
732
1598
|
requireId("team_id", team_id);
|
|
@@ -737,6 +1603,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
737
1603
|
* `POST /team` — operationId: `team/create`
|
|
738
1604
|
*
|
|
739
1605
|
* Create Team
|
|
1606
|
+
*
|
|
1607
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1608
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1609
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1610
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1611
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1612
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1613
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1614
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1615
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
740
1616
|
*/
|
|
741
1617
|
teamCreate(data) {
|
|
742
1618
|
return this.fetcher.post(`/team`, data);
|
|
@@ -745,6 +1621,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
745
1621
|
* `DELETE /team/{team_id}` — operationId: `team/delete`
|
|
746
1622
|
*
|
|
747
1623
|
* Delete Team
|
|
1624
|
+
*
|
|
1625
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1626
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1627
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1628
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1629
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1630
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1631
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1632
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1633
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1634
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
748
1635
|
*/
|
|
749
1636
|
teamDelete(team_id) {
|
|
750
1637
|
requireId("team_id", team_id);
|
|
@@ -754,6 +1641,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
754
1641
|
* `GET /team/{team_id}` — operationId: `team/get`
|
|
755
1642
|
*
|
|
756
1643
|
* Get Team
|
|
1644
|
+
*
|
|
1645
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1646
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1647
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1648
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1649
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1650
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1651
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1652
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1653
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1654
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1655
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
757
1656
|
*/
|
|
758
1657
|
teamGet(team_id) {
|
|
759
1658
|
requireId("team_id", team_id);
|
|
@@ -765,6 +1664,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
765
1664
|
* Invite a user to a Team by email
|
|
766
1665
|
*
|
|
767
1666
|
* 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.
|
|
1667
|
+
*
|
|
1668
|
+
* @throws {FaableApiError} `invite_used` (400) — The invite was already accepted.
|
|
1669
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1670
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1671
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1672
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1673
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1674
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1675
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1676
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
768
1677
|
*/
|
|
769
1678
|
teamInvite(team_id, data) {
|
|
770
1679
|
requireId("team_id", team_id);
|
|
@@ -774,6 +1683,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
774
1683
|
* `GET /team` — operationId: `team/list`
|
|
775
1684
|
*
|
|
776
1685
|
* List Teams
|
|
1686
|
+
*
|
|
1687
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1688
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1689
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1690
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1691
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1692
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1693
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1694
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1695
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1696
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1697
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
777
1698
|
*/
|
|
778
1699
|
teamList(params) {
|
|
779
1700
|
return this.paginator({ url: `/team`, params });
|
|
@@ -784,6 +1705,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
784
1705
|
* List pending invites for a Team
|
|
785
1706
|
*
|
|
786
1707
|
* Returns all pending (not consumed, not expired) team invites for the given team. Accepts a FaableQL `query` parameter on the `email` field.
|
|
1708
|
+
*
|
|
1709
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1710
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1711
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1712
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1713
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1714
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1715
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1716
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
787
1717
|
*/
|
|
788
1718
|
teamListInvites(team_id, params) {
|
|
789
1719
|
requireId("team_id", team_id);
|
|
@@ -795,6 +1725,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
795
1725
|
* List Team Members
|
|
796
1726
|
*
|
|
797
1727
|
* List all Users that belong to the given Team in the current Account. Supports `?expand=user,team,roles` to inline referenced rows.
|
|
1728
|
+
*
|
|
1729
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1730
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1731
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1732
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1733
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1734
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1735
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1736
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
798
1737
|
*/
|
|
799
1738
|
teamListMembers(team_id, params) {
|
|
800
1739
|
requireId("team_id", team_id);
|
|
@@ -806,6 +1745,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
806
1745
|
* Revoke a pending team invite
|
|
807
1746
|
*
|
|
808
1747
|
* 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.
|
|
1748
|
+
*
|
|
1749
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1750
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1751
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1752
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1753
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1754
|
+
* @throws {FaableApiError} `invite_not_found` (404) — No invite with that id in this account.
|
|
1755
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1756
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1757
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
809
1758
|
*/
|
|
810
1759
|
teamRevokeInvite(team_id, ticket_id) {
|
|
811
1760
|
requireId("team_id", team_id);
|
|
@@ -816,6 +1765,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
816
1765
|
* `POST /team/{team_id}` — operationId: `team/update`
|
|
817
1766
|
*
|
|
818
1767
|
* Update Team
|
|
1768
|
+
*
|
|
1769
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1770
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1771
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1772
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1773
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1774
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1775
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1776
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1777
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1778
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1779
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
819
1780
|
*/
|
|
820
1781
|
teamUpdate(team_id, data) {
|
|
821
1782
|
requireId("team_id", team_id);
|
|
@@ -825,6 +1786,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
825
1786
|
* `POST /teammember` — operationId: `teammember/create`
|
|
826
1787
|
*
|
|
827
1788
|
* Create Teammember
|
|
1789
|
+
*
|
|
1790
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1791
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1792
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1793
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1794
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1795
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1796
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1797
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1798
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
828
1799
|
*/
|
|
829
1800
|
teammemberCreate(data) {
|
|
830
1801
|
return this.fetcher.post(`/teammember`, data);
|
|
@@ -833,6 +1804,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
833
1804
|
* `DELETE /teammember/{teammember_id}` — operationId: `teammember/delete`
|
|
834
1805
|
*
|
|
835
1806
|
* Delete Teammember
|
|
1807
|
+
*
|
|
1808
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1809
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1810
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1811
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1812
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1813
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1814
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1815
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1816
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1817
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
836
1818
|
*/
|
|
837
1819
|
teammemberDelete(teammember_id) {
|
|
838
1820
|
requireId("teammember_id", teammember_id);
|
|
@@ -842,6 +1824,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
842
1824
|
* `GET /teammember/{teammember_id}` — operationId: `teammember/get`
|
|
843
1825
|
*
|
|
844
1826
|
* Get Teammember
|
|
1827
|
+
*
|
|
1828
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1829
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1830
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1831
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1832
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1833
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1834
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1835
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1836
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1837
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1838
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
845
1839
|
*/
|
|
846
1840
|
teammemberGet(teammember_id, params) {
|
|
847
1841
|
requireId("teammember_id", teammember_id);
|
|
@@ -851,6 +1845,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
851
1845
|
* `GET /teammember` — operationId: `teammember/list`
|
|
852
1846
|
*
|
|
853
1847
|
* List Teammembers
|
|
1848
|
+
*
|
|
1849
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1850
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1851
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1852
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1853
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1854
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1855
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1856
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1857
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1858
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1859
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
854
1860
|
*/
|
|
855
1861
|
teammemberList(params) {
|
|
856
1862
|
return this.paginator({ url: `/teammember`, params });
|
|
@@ -859,6 +1865,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
859
1865
|
* `POST /user` — operationId: `user/create`
|
|
860
1866
|
*
|
|
861
1867
|
* Create User
|
|
1868
|
+
*
|
|
1869
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
1870
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1871
|
+
* @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.
|
|
1872
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1873
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1874
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1875
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1876
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1877
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1878
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
862
1879
|
*/
|
|
863
1880
|
userCreate(data) {
|
|
864
1881
|
return this.fetcher.post(`/user`, data);
|
|
@@ -867,6 +1884,17 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
867
1884
|
* `DELETE /user/{user_id}` — operationId: `user/delete`
|
|
868
1885
|
*
|
|
869
1886
|
* Delete User
|
|
1887
|
+
*
|
|
1888
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1889
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1890
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1891
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1892
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1893
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1894
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1895
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1896
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1897
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
870
1898
|
*/
|
|
871
1899
|
userDelete(user_id) {
|
|
872
1900
|
requireId("user_id", user_id);
|
|
@@ -876,6 +1904,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
876
1904
|
* `GET /user/{user_id}` — operationId: `user/get`
|
|
877
1905
|
*
|
|
878
1906
|
* Get User
|
|
1907
|
+
*
|
|
1908
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
1909
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1910
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1911
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1912
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1913
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1914
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1915
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
1916
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1917
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1918
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
879
1919
|
*/
|
|
880
1920
|
userGet(user_id) {
|
|
881
1921
|
requireId("user_id", user_id);
|
|
@@ -885,6 +1925,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
885
1925
|
* `GET /user` — operationId: `user/list`
|
|
886
1926
|
*
|
|
887
1927
|
* List Users
|
|
1928
|
+
*
|
|
1929
|
+
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
1930
|
+
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
1931
|
+
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
1932
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1933
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1934
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1935
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1936
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1937
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1938
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1939
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
888
1940
|
*/
|
|
889
1941
|
userList(params) {
|
|
890
1942
|
return this.paginator({ url: `/user`, params });
|
|
@@ -895,6 +1947,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
895
1947
|
* List the tickets issued for a user
|
|
896
1948
|
*
|
|
897
1949
|
* 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.
|
|
1950
|
+
*
|
|
1951
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1952
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1953
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1954
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1955
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1956
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1957
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1958
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
898
1959
|
*/
|
|
899
1960
|
userListTickets(user_id) {
|
|
900
1961
|
requireId("user_id", user_id);
|
|
@@ -906,6 +1967,18 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
906
1967
|
* Send a password setup / reset email to the user
|
|
907
1968
|
*
|
|
908
1969
|
* 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.
|
|
1970
|
+
*
|
|
1971
|
+
* @throws {FaableApiError} `invalid_client` (400) — The `client_id` in the request does not name a client of this account.
|
|
1972
|
+
* @throws {FaableApiError} `invalid_connection` (400) — The connection does not exist, is disabled, or is not of the type this flow needs.
|
|
1973
|
+
* @throws {FaableApiError} `user_has_no_email` (400) — The operation needs an email but the user has none.
|
|
1974
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1975
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1976
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1977
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1978
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1979
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
1980
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
1981
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
909
1982
|
*/
|
|
910
1983
|
userPasswordSetup(user_id, data) {
|
|
911
1984
|
requireId("user_id", user_id);
|
|
@@ -917,6 +1990,16 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
917
1990
|
* Revoke a ticket issued for a user
|
|
918
1991
|
*
|
|
919
1992
|
* 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.
|
|
1993
|
+
*
|
|
1994
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
1995
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
1996
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
1997
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
1998
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
1999
|
+
* @throws {FaableApiError} `ticket_not_found` (404) — No ticket with that id belongs to this user.
|
|
2000
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2001
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2002
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
920
2003
|
*/
|
|
921
2004
|
userRevokeTicket(user_id, ticket_id) {
|
|
922
2005
|
requireId("user_id", user_id);
|
|
@@ -927,6 +2010,19 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
927
2010
|
* `POST /user/{user_id}` — operationId: `user/update`
|
|
928
2011
|
*
|
|
929
2012
|
* Update User
|
|
2013
|
+
*
|
|
2014
|
+
* @throws {FaableApiError} `invalid_id` (400) — The id in the path is not a valid id for this resource.
|
|
2015
|
+
* @throws {FaableApiError} `already_exists` (400) — A resource with the same unique field already exists (for a user, usually `email`). `details.fields` names the field.
|
|
2016
|
+
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2017
|
+
* @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.
|
|
2018
|
+
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2019
|
+
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2020
|
+
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2021
|
+
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2022
|
+
* @throws {FaableApiError} `not_found` (404) — The resource does not exist in this account.
|
|
2023
|
+
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2024
|
+
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2025
|
+
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
930
2026
|
*/
|
|
931
2027
|
userUpdate(user_id, data) {
|
|
932
2028
|
requireId("user_id", user_id);
|