@faable/auth-sdk 2.7.86 → 2.7.88
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api/generated-client.d.ts +0 -51
- package/dist/api/types.d.ts +100 -0
- package/dist/version.js +2 -2
- package/package.json +1 -1
- package/spec/openapi.json +194 -1
|
@@ -2117,23 +2117,6 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2117
2117
|
issuer: string;
|
|
2118
2118
|
jwks_url: string;
|
|
2119
2119
|
response_type: string;
|
|
2120
|
-
/**
|
|
2121
|
-
* `GET /teammember` — operationId: `teammember/list`
|
|
2122
|
-
*
|
|
2123
|
-
* List Teammembers
|
|
2124
|
-
*
|
|
2125
|
-
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2126
|
-
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2127
|
-
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2128
|
-
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2129
|
-
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2130
|
-
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2131
|
-
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2132
|
-
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2133
|
-
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2134
|
-
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2135
|
-
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2136
|
-
*/
|
|
2137
2120
|
enabled: boolean;
|
|
2138
2121
|
organization?: string | null | undefined;
|
|
2139
2122
|
enabled_clients: string[] | null;
|
|
@@ -2175,23 +2158,6 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2175
2158
|
issuer: string;
|
|
2176
2159
|
jwks_url: string;
|
|
2177
2160
|
response_type: string;
|
|
2178
|
-
/**
|
|
2179
|
-
* `GET /teammember` — operationId: `teammember/list`
|
|
2180
|
-
*
|
|
2181
|
-
* List Teammembers
|
|
2182
|
-
*
|
|
2183
|
-
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2184
|
-
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2185
|
-
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2186
|
-
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2187
|
-
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2188
|
-
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2189
|
-
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2190
|
-
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2191
|
-
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2192
|
-
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2193
|
-
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2194
|
-
*/
|
|
2195
2161
|
enabled: boolean;
|
|
2196
2162
|
organization?: string | null | undefined;
|
|
2197
2163
|
enabled_clients: string[] | null;
|
|
@@ -2236,23 +2202,6 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2236
2202
|
issuer: string;
|
|
2237
2203
|
jwks_url: string;
|
|
2238
2204
|
response_type: string;
|
|
2239
|
-
/**
|
|
2240
|
-
* `GET /teammember` — operationId: `teammember/list`
|
|
2241
|
-
*
|
|
2242
|
-
* List Teammembers
|
|
2243
|
-
*
|
|
2244
|
-
* @throws {FaableApiError} `invalid_query` (400) — The `?query=` FaableQL expression could not be parsed.
|
|
2245
|
-
* @throws {FaableApiError} `invalid_expand` (400) — An `?expand=` path is not allowed on this resource.
|
|
2246
|
-
* @throws {FaableApiError} `search_not_supported` (400) — This resource does not support `?search=`.
|
|
2247
|
-
* @throws {FaableApiError} `validation_error` (400) — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
2248
|
-
* @throws {FaableApiError} `unauthorized` (401) — The request carries no valid credentials.
|
|
2249
|
-
* @throws {FaableApiError} `forbidden` (403) — The credentials are valid but do not allow this operation.
|
|
2250
|
-
* @throws {FaableApiError} `insufficient_scope` (403) — The token lacks a scope this operation requires. `message` names it.
|
|
2251
|
-
* @throws {FaableApiError} `user_suspended` (403) — The user is suspended and cannot sign in or be modified.
|
|
2252
|
-
* @throws {FaableApiError} `account_not_found` (404) — No Auth Account matches the request (domain, header or token).
|
|
2253
|
-
* @throws {FaableApiError} `too_many_requests` (429) — Rate limit exceeded. Honour the `Retry-After` header.
|
|
2254
|
-
* @throws {FaableApiError} `internal_error` (500) — Unexpected server error. Retry later; the request id is logged.
|
|
2255
|
-
*/
|
|
2256
2205
|
enabled: boolean;
|
|
2257
2206
|
organization?: string | null | undefined;
|
|
2258
2207
|
enabled_clients: string[] | null;
|
package/dist/api/types.d.ts
CHANGED
|
@@ -416,6 +416,26 @@ export interface paths {
|
|
|
416
416
|
patch?: never;
|
|
417
417
|
trace?: never;
|
|
418
418
|
};
|
|
419
|
+
"/login/home-realm": {
|
|
420
|
+
parameters: {
|
|
421
|
+
query?: never;
|
|
422
|
+
header?: never;
|
|
423
|
+
path?: never;
|
|
424
|
+
cookie?: never;
|
|
425
|
+
};
|
|
426
|
+
/**
|
|
427
|
+
* Where an email signs in (home realm discovery)
|
|
428
|
+
* @description If the identifier is an email of an organization's verified domain and that organization has its own identity provider, its connection: start the login with `connection=<connection_id>` instead of a password or code. `home_realm: null` for everybody else.
|
|
429
|
+
*/
|
|
430
|
+
get: operations["login/homeRealm"];
|
|
431
|
+
put?: never;
|
|
432
|
+
post?: never;
|
|
433
|
+
delete?: never;
|
|
434
|
+
options?: never;
|
|
435
|
+
head?: never;
|
|
436
|
+
patch?: never;
|
|
437
|
+
trace?: never;
|
|
438
|
+
};
|
|
419
439
|
"/login/identify": {
|
|
420
440
|
parameters: {
|
|
421
441
|
query?: never;
|
|
@@ -10940,6 +10960,86 @@ export interface operations {
|
|
|
10940
10960
|
};
|
|
10941
10961
|
};
|
|
10942
10962
|
};
|
|
10963
|
+
"login/homeRealm": {
|
|
10964
|
+
parameters: {
|
|
10965
|
+
query: {
|
|
10966
|
+
identifier: string;
|
|
10967
|
+
client_id?: string;
|
|
10968
|
+
};
|
|
10969
|
+
header?: never;
|
|
10970
|
+
path?: never;
|
|
10971
|
+
cookie?: never;
|
|
10972
|
+
};
|
|
10973
|
+
requestBody?: never;
|
|
10974
|
+
responses: {
|
|
10975
|
+
/** @description Default Response */
|
|
10976
|
+
200: {
|
|
10977
|
+
headers: {
|
|
10978
|
+
[name: string]: unknown;
|
|
10979
|
+
};
|
|
10980
|
+
content: {
|
|
10981
|
+
"application/json": {
|
|
10982
|
+
home_realm: {
|
|
10983
|
+
connection_id: string;
|
|
10984
|
+
organization: {
|
|
10985
|
+
id: string;
|
|
10986
|
+
name: string;
|
|
10987
|
+
logo_url: string | null;
|
|
10988
|
+
};
|
|
10989
|
+
} | null;
|
|
10990
|
+
};
|
|
10991
|
+
};
|
|
10992
|
+
};
|
|
10993
|
+
/** @description `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field. */
|
|
10994
|
+
400: {
|
|
10995
|
+
headers: {
|
|
10996
|
+
[name: string]: unknown;
|
|
10997
|
+
};
|
|
10998
|
+
content: {
|
|
10999
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
11000
|
+
/** @enum {string} */
|
|
11001
|
+
error_code?: "validation_error";
|
|
11002
|
+
};
|
|
11003
|
+
};
|
|
11004
|
+
};
|
|
11005
|
+
/** @description `account_not_found` — No Auth Account matches the request (domain, header or token). */
|
|
11006
|
+
404: {
|
|
11007
|
+
headers: {
|
|
11008
|
+
[name: string]: unknown;
|
|
11009
|
+
};
|
|
11010
|
+
content: {
|
|
11011
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
11012
|
+
/** @enum {string} */
|
|
11013
|
+
error_code?: "account_not_found";
|
|
11014
|
+
};
|
|
11015
|
+
};
|
|
11016
|
+
};
|
|
11017
|
+
/** @description `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header. */
|
|
11018
|
+
429: {
|
|
11019
|
+
headers: {
|
|
11020
|
+
[name: string]: unknown;
|
|
11021
|
+
};
|
|
11022
|
+
content: {
|
|
11023
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
11024
|
+
/** @enum {string} */
|
|
11025
|
+
error_code?: "too_many_requests";
|
|
11026
|
+
};
|
|
11027
|
+
};
|
|
11028
|
+
};
|
|
11029
|
+
/** @description `internal_error` — Unexpected server error. Retry later; the request id is logged. */
|
|
11030
|
+
500: {
|
|
11031
|
+
headers: {
|
|
11032
|
+
[name: string]: unknown;
|
|
11033
|
+
};
|
|
11034
|
+
content: {
|
|
11035
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
11036
|
+
/** @enum {string} */
|
|
11037
|
+
error_code?: "internal_error";
|
|
11038
|
+
};
|
|
11039
|
+
};
|
|
11040
|
+
};
|
|
11041
|
+
};
|
|
11042
|
+
};
|
|
10943
11043
|
"login/identify": {
|
|
10944
11044
|
parameters: {
|
|
10945
11045
|
query?: never;
|
package/dist/version.js
CHANGED
|
@@ -9,13 +9,13 @@
|
|
|
9
9
|
// login pages could not import the SDK at all. Same pattern as auth-js.
|
|
10
10
|
//
|
|
11
11
|
// The sentinels MUST stay byte-identical to the `from` values in `.releaserc`.
|
|
12
|
-
export const version = "2.7.
|
|
12
|
+
export const version = "2.7.88";
|
|
13
13
|
// Short git SHA of the released commit. The version dates a build; this names
|
|
14
14
|
// the exact tree, so a canonical log line or an audit entry leads straight to
|
|
15
15
|
// `git show <sha>`. Deliberately NOT hex: an unreleased build (dev, a local
|
|
16
16
|
// link) cannot be mistaken for a real commit — auth only records values that
|
|
17
17
|
// look like a SHA, and this one never will.
|
|
18
|
-
export const commit = "
|
|
18
|
+
export const commit = "d146d54";
|
|
19
19
|
// What this SDK writes in `x-faable-client`. Exported for a consumer that
|
|
20
20
|
// builds a strategy on its own (outside `FaableAuthApi`) and still wants the
|
|
21
21
|
// token request attributed — a bare `authClientCredentials` stamps only what
|
package/package.json
CHANGED
package/spec/openapi.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "@faablecloud/auth",
|
|
5
5
|
"description": "Auth Platform made by Faable. Manage Users and Roles",
|
|
6
|
-
"version": "2.
|
|
6
|
+
"version": "2.69.1",
|
|
7
7
|
"license": {
|
|
8
8
|
"name": "private",
|
|
9
9
|
"url": "https://faable.com/docs/platform/privacy-policy"
|
|
@@ -17415,6 +17415,199 @@
|
|
|
17415
17415
|
}
|
|
17416
17416
|
}
|
|
17417
17417
|
},
|
|
17418
|
+
"/login/home-realm": {
|
|
17419
|
+
"get": {
|
|
17420
|
+
"operationId": "login/homeRealm",
|
|
17421
|
+
"summary": "Where an email signs in (home realm discovery)",
|
|
17422
|
+
"tags": [
|
|
17423
|
+
"connection"
|
|
17424
|
+
],
|
|
17425
|
+
"description": "If the identifier is an email of an organization's verified domain and that organization has its own identity provider, its connection: start the login with `connection=<connection_id>` instead of a password or code. `home_realm: null` for everybody else.",
|
|
17426
|
+
"parameters": [
|
|
17427
|
+
{
|
|
17428
|
+
"schema": {
|
|
17429
|
+
"type": "string",
|
|
17430
|
+
"minLength": 1,
|
|
17431
|
+
"maxLength": 320
|
|
17432
|
+
},
|
|
17433
|
+
"in": "query",
|
|
17434
|
+
"name": "identifier",
|
|
17435
|
+
"required": true
|
|
17436
|
+
},
|
|
17437
|
+
{
|
|
17438
|
+
"schema": {
|
|
17439
|
+
"type": "string",
|
|
17440
|
+
"maxLength": 200
|
|
17441
|
+
},
|
|
17442
|
+
"in": "query",
|
|
17443
|
+
"name": "client_id",
|
|
17444
|
+
"required": false
|
|
17445
|
+
}
|
|
17446
|
+
],
|
|
17447
|
+
"responses": {
|
|
17448
|
+
"200": {
|
|
17449
|
+
"description": "Default Response",
|
|
17450
|
+
"content": {
|
|
17451
|
+
"application/json": {
|
|
17452
|
+
"schema": {
|
|
17453
|
+
"type": "object",
|
|
17454
|
+
"required": [
|
|
17455
|
+
"home_realm"
|
|
17456
|
+
],
|
|
17457
|
+
"properties": {
|
|
17458
|
+
"home_realm": {
|
|
17459
|
+
"anyOf": [
|
|
17460
|
+
{
|
|
17461
|
+
"type": "object",
|
|
17462
|
+
"required": [
|
|
17463
|
+
"connection_id",
|
|
17464
|
+
"organization"
|
|
17465
|
+
],
|
|
17466
|
+
"properties": {
|
|
17467
|
+
"connection_id": {
|
|
17468
|
+
"type": "string"
|
|
17469
|
+
},
|
|
17470
|
+
"organization": {
|
|
17471
|
+
"type": "object",
|
|
17472
|
+
"required": [
|
|
17473
|
+
"id",
|
|
17474
|
+
"name",
|
|
17475
|
+
"logo_url"
|
|
17476
|
+
],
|
|
17477
|
+
"properties": {
|
|
17478
|
+
"id": {
|
|
17479
|
+
"type": "string"
|
|
17480
|
+
},
|
|
17481
|
+
"name": {
|
|
17482
|
+
"type": "string"
|
|
17483
|
+
},
|
|
17484
|
+
"logo_url": {
|
|
17485
|
+
"anyOf": [
|
|
17486
|
+
{
|
|
17487
|
+
"type": "string"
|
|
17488
|
+
},
|
|
17489
|
+
{
|
|
17490
|
+
"type": "null"
|
|
17491
|
+
}
|
|
17492
|
+
]
|
|
17493
|
+
}
|
|
17494
|
+
}
|
|
17495
|
+
}
|
|
17496
|
+
}
|
|
17497
|
+
},
|
|
17498
|
+
{
|
|
17499
|
+
"type": "null"
|
|
17500
|
+
}
|
|
17501
|
+
]
|
|
17502
|
+
}
|
|
17503
|
+
}
|
|
17504
|
+
}
|
|
17505
|
+
}
|
|
17506
|
+
}
|
|
17507
|
+
},
|
|
17508
|
+
"400": {
|
|
17509
|
+
"description": "`validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.",
|
|
17510
|
+
"content": {
|
|
17511
|
+
"application/json": {
|
|
17512
|
+
"schema": {
|
|
17513
|
+
"allOf": [
|
|
17514
|
+
{
|
|
17515
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
17516
|
+
},
|
|
17517
|
+
{
|
|
17518
|
+
"type": "object",
|
|
17519
|
+
"properties": {
|
|
17520
|
+
"error_code": {
|
|
17521
|
+
"type": "string",
|
|
17522
|
+
"enum": [
|
|
17523
|
+
"validation_error"
|
|
17524
|
+
]
|
|
17525
|
+
}
|
|
17526
|
+
}
|
|
17527
|
+
}
|
|
17528
|
+
]
|
|
17529
|
+
}
|
|
17530
|
+
}
|
|
17531
|
+
}
|
|
17532
|
+
},
|
|
17533
|
+
"404": {
|
|
17534
|
+
"description": "`account_not_found` — No Auth Account matches the request (domain, header or token).",
|
|
17535
|
+
"content": {
|
|
17536
|
+
"application/json": {
|
|
17537
|
+
"schema": {
|
|
17538
|
+
"allOf": [
|
|
17539
|
+
{
|
|
17540
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
17541
|
+
},
|
|
17542
|
+
{
|
|
17543
|
+
"type": "object",
|
|
17544
|
+
"properties": {
|
|
17545
|
+
"error_code": {
|
|
17546
|
+
"type": "string",
|
|
17547
|
+
"enum": [
|
|
17548
|
+
"account_not_found"
|
|
17549
|
+
]
|
|
17550
|
+
}
|
|
17551
|
+
}
|
|
17552
|
+
}
|
|
17553
|
+
]
|
|
17554
|
+
}
|
|
17555
|
+
}
|
|
17556
|
+
}
|
|
17557
|
+
},
|
|
17558
|
+
"429": {
|
|
17559
|
+
"description": "`too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.",
|
|
17560
|
+
"content": {
|
|
17561
|
+
"application/json": {
|
|
17562
|
+
"schema": {
|
|
17563
|
+
"allOf": [
|
|
17564
|
+
{
|
|
17565
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
17566
|
+
},
|
|
17567
|
+
{
|
|
17568
|
+
"type": "object",
|
|
17569
|
+
"properties": {
|
|
17570
|
+
"error_code": {
|
|
17571
|
+
"type": "string",
|
|
17572
|
+
"enum": [
|
|
17573
|
+
"too_many_requests"
|
|
17574
|
+
]
|
|
17575
|
+
}
|
|
17576
|
+
}
|
|
17577
|
+
}
|
|
17578
|
+
]
|
|
17579
|
+
}
|
|
17580
|
+
}
|
|
17581
|
+
}
|
|
17582
|
+
},
|
|
17583
|
+
"500": {
|
|
17584
|
+
"description": "`internal_error` — Unexpected server error. Retry later; the request id is logged.",
|
|
17585
|
+
"content": {
|
|
17586
|
+
"application/json": {
|
|
17587
|
+
"schema": {
|
|
17588
|
+
"allOf": [
|
|
17589
|
+
{
|
|
17590
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
17591
|
+
},
|
|
17592
|
+
{
|
|
17593
|
+
"type": "object",
|
|
17594
|
+
"properties": {
|
|
17595
|
+
"error_code": {
|
|
17596
|
+
"type": "string",
|
|
17597
|
+
"enum": [
|
|
17598
|
+
"internal_error"
|
|
17599
|
+
]
|
|
17600
|
+
}
|
|
17601
|
+
}
|
|
17602
|
+
}
|
|
17603
|
+
]
|
|
17604
|
+
}
|
|
17605
|
+
}
|
|
17606
|
+
}
|
|
17607
|
+
}
|
|
17608
|
+
}
|
|
17609
|
+
}
|
|
17610
|
+
},
|
|
17418
17611
|
"/login/identify": {
|
|
17419
17612
|
"post": {
|
|
17420
17613
|
"operationId": "login/identify",
|