@faable/auth-sdk 2.9.3 → 2.9.4
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/types.d.ts +93 -0
- package/dist/version.js +2 -2
- package/package.json +1 -1
- package/spec/openapi.json +144 -1
package/dist/api/types.d.ts
CHANGED
|
@@ -436,6 +436,26 @@ export interface paths {
|
|
|
436
436
|
patch?: never;
|
|
437
437
|
trace?: never;
|
|
438
438
|
};
|
|
439
|
+
"/login-host": {
|
|
440
|
+
parameters: {
|
|
441
|
+
query?: never;
|
|
442
|
+
header?: never;
|
|
443
|
+
path?: never;
|
|
444
|
+
cookie?: never;
|
|
445
|
+
};
|
|
446
|
+
/**
|
|
447
|
+
* Find the login host of a client's tenant
|
|
448
|
+
* @description The host where the hosted login screens of the tenant that owns this `client_id` are served. Lets a login URL opened on the wrong host be sent to the right one. Not tenant-scoped: callable on any auth host.
|
|
449
|
+
*/
|
|
450
|
+
get: operations["client/loginHost"];
|
|
451
|
+
put?: never;
|
|
452
|
+
post?: never;
|
|
453
|
+
delete?: never;
|
|
454
|
+
options?: never;
|
|
455
|
+
head?: never;
|
|
456
|
+
patch?: never;
|
|
457
|
+
trace?: never;
|
|
458
|
+
};
|
|
439
459
|
"/login/home-realm": {
|
|
440
460
|
parameters: {
|
|
441
461
|
query?: never;
|
|
@@ -12527,6 +12547,79 @@ export interface operations {
|
|
|
12527
12547
|
};
|
|
12528
12548
|
};
|
|
12529
12549
|
};
|
|
12550
|
+
"client/loginHost": {
|
|
12551
|
+
parameters: {
|
|
12552
|
+
query: {
|
|
12553
|
+
client_id: string;
|
|
12554
|
+
};
|
|
12555
|
+
header?: never;
|
|
12556
|
+
path?: never;
|
|
12557
|
+
cookie?: never;
|
|
12558
|
+
};
|
|
12559
|
+
requestBody?: never;
|
|
12560
|
+
responses: {
|
|
12561
|
+
/** @description Default Response */
|
|
12562
|
+
200: {
|
|
12563
|
+
headers: {
|
|
12564
|
+
[name: string]: unknown;
|
|
12565
|
+
};
|
|
12566
|
+
content: {
|
|
12567
|
+
"application/json": {
|
|
12568
|
+
/** @description The tenant's login host: its `canonical_host` when set, else its platform host. */
|
|
12569
|
+
host: string;
|
|
12570
|
+
};
|
|
12571
|
+
};
|
|
12572
|
+
};
|
|
12573
|
+
/** @description `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field. */
|
|
12574
|
+
400: {
|
|
12575
|
+
headers: {
|
|
12576
|
+
[name: string]: unknown;
|
|
12577
|
+
};
|
|
12578
|
+
content: {
|
|
12579
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
12580
|
+
/** @enum {string} */
|
|
12581
|
+
error_code?: "validation_error";
|
|
12582
|
+
};
|
|
12583
|
+
};
|
|
12584
|
+
};
|
|
12585
|
+
/** @description `account_not_found` — No Auth Account matches the request (domain, header or token). */
|
|
12586
|
+
404: {
|
|
12587
|
+
headers: {
|
|
12588
|
+
[name: string]: unknown;
|
|
12589
|
+
};
|
|
12590
|
+
content: {
|
|
12591
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
12592
|
+
/** @enum {string} */
|
|
12593
|
+
error_code?: "account_not_found";
|
|
12594
|
+
};
|
|
12595
|
+
};
|
|
12596
|
+
};
|
|
12597
|
+
/** @description `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header. */
|
|
12598
|
+
429: {
|
|
12599
|
+
headers: {
|
|
12600
|
+
[name: string]: unknown;
|
|
12601
|
+
};
|
|
12602
|
+
content: {
|
|
12603
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
12604
|
+
/** @enum {string} */
|
|
12605
|
+
error_code?: "too_many_requests";
|
|
12606
|
+
};
|
|
12607
|
+
};
|
|
12608
|
+
};
|
|
12609
|
+
/** @description `internal_error` — Unexpected server error. Retry later; the request id is logged. */
|
|
12610
|
+
500: {
|
|
12611
|
+
headers: {
|
|
12612
|
+
[name: string]: unknown;
|
|
12613
|
+
};
|
|
12614
|
+
content: {
|
|
12615
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
12616
|
+
/** @enum {string} */
|
|
12617
|
+
error_code?: "internal_error";
|
|
12618
|
+
};
|
|
12619
|
+
};
|
|
12620
|
+
};
|
|
12621
|
+
};
|
|
12622
|
+
};
|
|
12530
12623
|
"login/homeRealm": {
|
|
12531
12624
|
parameters: {
|
|
12532
12625
|
query: {
|
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.9.
|
|
12
|
+
export const version = "2.9.4";
|
|
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 = "eb2f9b1";
|
|
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.95.0",
|
|
7
7
|
"license": {
|
|
8
8
|
"name": "private",
|
|
9
9
|
"url": "https://faable.com/docs/platform/privacy-policy"
|
|
@@ -20054,6 +20054,149 @@
|
|
|
20054
20054
|
}
|
|
20055
20055
|
}
|
|
20056
20056
|
},
|
|
20057
|
+
"/login-host": {
|
|
20058
|
+
"get": {
|
|
20059
|
+
"operationId": "client/loginHost",
|
|
20060
|
+
"summary": "Find the login host of a client's tenant",
|
|
20061
|
+
"tags": [
|
|
20062
|
+
"client"
|
|
20063
|
+
],
|
|
20064
|
+
"description": "The host where the hosted login screens of the tenant that owns this `client_id` are served. Lets a login URL opened on the wrong host be sent to the right one. Not tenant-scoped: callable on any auth host.",
|
|
20065
|
+
"parameters": [
|
|
20066
|
+
{
|
|
20067
|
+
"schema": {
|
|
20068
|
+
"type": "string",
|
|
20069
|
+
"minLength": 1,
|
|
20070
|
+
"maxLength": 200
|
|
20071
|
+
},
|
|
20072
|
+
"in": "query",
|
|
20073
|
+
"name": "client_id",
|
|
20074
|
+
"required": true
|
|
20075
|
+
}
|
|
20076
|
+
],
|
|
20077
|
+
"responses": {
|
|
20078
|
+
"200": {
|
|
20079
|
+
"description": "Default Response",
|
|
20080
|
+
"content": {
|
|
20081
|
+
"application/json": {
|
|
20082
|
+
"schema": {
|
|
20083
|
+
"type": "object",
|
|
20084
|
+
"required": [
|
|
20085
|
+
"host"
|
|
20086
|
+
],
|
|
20087
|
+
"properties": {
|
|
20088
|
+
"host": {
|
|
20089
|
+
"type": "string",
|
|
20090
|
+
"description": "The tenant's login host: its `canonical_host` when set, else its platform host."
|
|
20091
|
+
}
|
|
20092
|
+
}
|
|
20093
|
+
}
|
|
20094
|
+
}
|
|
20095
|
+
}
|
|
20096
|
+
},
|
|
20097
|
+
"400": {
|
|
20098
|
+
"description": "`validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.",
|
|
20099
|
+
"content": {
|
|
20100
|
+
"application/json": {
|
|
20101
|
+
"schema": {
|
|
20102
|
+
"allOf": [
|
|
20103
|
+
{
|
|
20104
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
20105
|
+
},
|
|
20106
|
+
{
|
|
20107
|
+
"type": "object",
|
|
20108
|
+
"properties": {
|
|
20109
|
+
"error_code": {
|
|
20110
|
+
"type": "string",
|
|
20111
|
+
"enum": [
|
|
20112
|
+
"validation_error"
|
|
20113
|
+
]
|
|
20114
|
+
}
|
|
20115
|
+
}
|
|
20116
|
+
}
|
|
20117
|
+
]
|
|
20118
|
+
}
|
|
20119
|
+
}
|
|
20120
|
+
}
|
|
20121
|
+
},
|
|
20122
|
+
"404": {
|
|
20123
|
+
"description": "`account_not_found` — No Auth Account matches the request (domain, header or token).",
|
|
20124
|
+
"content": {
|
|
20125
|
+
"application/json": {
|
|
20126
|
+
"schema": {
|
|
20127
|
+
"allOf": [
|
|
20128
|
+
{
|
|
20129
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
20130
|
+
},
|
|
20131
|
+
{
|
|
20132
|
+
"type": "object",
|
|
20133
|
+
"properties": {
|
|
20134
|
+
"error_code": {
|
|
20135
|
+
"type": "string",
|
|
20136
|
+
"enum": [
|
|
20137
|
+
"account_not_found"
|
|
20138
|
+
]
|
|
20139
|
+
}
|
|
20140
|
+
}
|
|
20141
|
+
}
|
|
20142
|
+
]
|
|
20143
|
+
}
|
|
20144
|
+
}
|
|
20145
|
+
}
|
|
20146
|
+
},
|
|
20147
|
+
"429": {
|
|
20148
|
+
"description": "`too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.",
|
|
20149
|
+
"content": {
|
|
20150
|
+
"application/json": {
|
|
20151
|
+
"schema": {
|
|
20152
|
+
"allOf": [
|
|
20153
|
+
{
|
|
20154
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
20155
|
+
},
|
|
20156
|
+
{
|
|
20157
|
+
"type": "object",
|
|
20158
|
+
"properties": {
|
|
20159
|
+
"error_code": {
|
|
20160
|
+
"type": "string",
|
|
20161
|
+
"enum": [
|
|
20162
|
+
"too_many_requests"
|
|
20163
|
+
]
|
|
20164
|
+
}
|
|
20165
|
+
}
|
|
20166
|
+
}
|
|
20167
|
+
]
|
|
20168
|
+
}
|
|
20169
|
+
}
|
|
20170
|
+
}
|
|
20171
|
+
},
|
|
20172
|
+
"500": {
|
|
20173
|
+
"description": "`internal_error` — Unexpected server error. Retry later; the request id is logged.",
|
|
20174
|
+
"content": {
|
|
20175
|
+
"application/json": {
|
|
20176
|
+
"schema": {
|
|
20177
|
+
"allOf": [
|
|
20178
|
+
{
|
|
20179
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
20180
|
+
},
|
|
20181
|
+
{
|
|
20182
|
+
"type": "object",
|
|
20183
|
+
"properties": {
|
|
20184
|
+
"error_code": {
|
|
20185
|
+
"type": "string",
|
|
20186
|
+
"enum": [
|
|
20187
|
+
"internal_error"
|
|
20188
|
+
]
|
|
20189
|
+
}
|
|
20190
|
+
}
|
|
20191
|
+
}
|
|
20192
|
+
]
|
|
20193
|
+
}
|
|
20194
|
+
}
|
|
20195
|
+
}
|
|
20196
|
+
}
|
|
20197
|
+
}
|
|
20198
|
+
}
|
|
20199
|
+
},
|
|
20057
20200
|
"/login/home-realm": {
|
|
20058
20201
|
"get": {
|
|
20059
20202
|
"operationId": "login/homeRealm",
|