@faable/auth-sdk 2.5.3 → 2.5.5
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 +10 -0
- package/dist/api/generated-client.js +9 -0
- package/dist/api/types.d.ts +54 -0
- package/package.json +1 -1
- package/spec/openapi.json +74 -1
|
@@ -2921,6 +2921,16 @@ export declare abstract class GeneratedFaableAuthApi extends FaableApi {
|
|
|
2921
2921
|
updatedAt?: string | undefined;
|
|
2922
2922
|
}>>;
|
|
2923
2923
|
};
|
|
2924
|
+
/**
|
|
2925
|
+
* `POST /user/{user_id}/password-setup` — operationId: `user/passwordSetup`
|
|
2926
|
+
*
|
|
2927
|
+
* Send a password setup / reset email to the user
|
|
2928
|
+
*/
|
|
2929
|
+
userPasswordSetup(user_id: string, data: OpBody<"user/passwordSetup">): Promise<{
|
|
2930
|
+
status: "sent";
|
|
2931
|
+
credential_id: string;
|
|
2932
|
+
ticket_id: string;
|
|
2933
|
+
}>;
|
|
2924
2934
|
/**
|
|
2925
2935
|
* `POST /user/{user_id}` — operationId: `user/update`
|
|
2926
2936
|
*
|
|
@@ -717,6 +717,15 @@ export class GeneratedFaableAuthApi extends FaableApi {
|
|
|
717
717
|
userList(params) {
|
|
718
718
|
return this.paginator({ url: `/user`, params });
|
|
719
719
|
}
|
|
720
|
+
/**
|
|
721
|
+
* `POST /user/{user_id}/password-setup` — operationId: `user/passwordSetup`
|
|
722
|
+
*
|
|
723
|
+
* Send a password setup / reset email to the user
|
|
724
|
+
*/
|
|
725
|
+
userPasswordSetup(user_id, data) {
|
|
726
|
+
requireId("user_id", user_id);
|
|
727
|
+
return this.fetcher.post(`/user/${user_id}/password-setup`, data);
|
|
728
|
+
}
|
|
720
729
|
/**
|
|
721
730
|
* `POST /user/{user_id}` — operationId: `user/update`
|
|
722
731
|
*
|
package/dist/api/types.d.ts
CHANGED
|
@@ -384,6 +384,26 @@ export interface paths {
|
|
|
384
384
|
patch?: never;
|
|
385
385
|
trace?: never;
|
|
386
386
|
};
|
|
387
|
+
"/user/{user_id}/password-setup": {
|
|
388
|
+
parameters: {
|
|
389
|
+
query?: never;
|
|
390
|
+
header?: never;
|
|
391
|
+
path?: never;
|
|
392
|
+
cookie?: never;
|
|
393
|
+
};
|
|
394
|
+
get?: never;
|
|
395
|
+
put?: never;
|
|
396
|
+
/**
|
|
397
|
+
* Send a password setup / reset email to the user
|
|
398
|
+
* @description 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.
|
|
399
|
+
*/
|
|
400
|
+
post: operations["user/passwordSetup"];
|
|
401
|
+
delete?: never;
|
|
402
|
+
options?: never;
|
|
403
|
+
head?: never;
|
|
404
|
+
patch?: never;
|
|
405
|
+
trace?: never;
|
|
406
|
+
};
|
|
387
407
|
"/identity": {
|
|
388
408
|
parameters: {
|
|
389
409
|
query?: never;
|
|
@@ -5295,6 +5315,40 @@ export interface operations {
|
|
|
5295
5315
|
};
|
|
5296
5316
|
};
|
|
5297
5317
|
};
|
|
5318
|
+
"user/passwordSetup": {
|
|
5319
|
+
parameters: {
|
|
5320
|
+
query?: never;
|
|
5321
|
+
header?: never;
|
|
5322
|
+
path: {
|
|
5323
|
+
user_id: string;
|
|
5324
|
+
};
|
|
5325
|
+
cookie?: never;
|
|
5326
|
+
};
|
|
5327
|
+
requestBody: {
|
|
5328
|
+
content: {
|
|
5329
|
+
"application/json": {
|
|
5330
|
+
/** @description Optional connection_name to disambiguate when the tenant has more than one database connection. Defaults to the tenant database connection. */
|
|
5331
|
+
connection?: string;
|
|
5332
|
+
};
|
|
5333
|
+
};
|
|
5334
|
+
};
|
|
5335
|
+
responses: {
|
|
5336
|
+
/** @description Default Response */
|
|
5337
|
+
200: {
|
|
5338
|
+
headers: {
|
|
5339
|
+
[name: string]: unknown;
|
|
5340
|
+
};
|
|
5341
|
+
content: {
|
|
5342
|
+
"application/json": {
|
|
5343
|
+
/** @enum {string} */
|
|
5344
|
+
status: "sent";
|
|
5345
|
+
credential_id: string;
|
|
5346
|
+
ticket_id: string;
|
|
5347
|
+
};
|
|
5348
|
+
};
|
|
5349
|
+
};
|
|
5350
|
+
};
|
|
5351
|
+
};
|
|
5298
5352
|
"identity/list": {
|
|
5299
5353
|
parameters: {
|
|
5300
5354
|
query?: {
|
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": "1.
|
|
6
|
+
"version": "1.31.1",
|
|
7
7
|
"license": {
|
|
8
8
|
"name": "private",
|
|
9
9
|
"url": "https://faable.com/docs/platform/privacy-policy"
|
|
@@ -9915,6 +9915,79 @@
|
|
|
9915
9915
|
}
|
|
9916
9916
|
}
|
|
9917
9917
|
},
|
|
9918
|
+
"/user/{user_id}/password-setup": {
|
|
9919
|
+
"post": {
|
|
9920
|
+
"operationId": "user/passwordSetup",
|
|
9921
|
+
"summary": "Send a password setup / reset email to the user",
|
|
9922
|
+
"tags": [
|
|
9923
|
+
"user"
|
|
9924
|
+
],
|
|
9925
|
+
"description": "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.",
|
|
9926
|
+
"requestBody": {
|
|
9927
|
+
"required": true,
|
|
9928
|
+
"content": {
|
|
9929
|
+
"application/json": {
|
|
9930
|
+
"schema": {
|
|
9931
|
+
"type": "object",
|
|
9932
|
+
"properties": {
|
|
9933
|
+
"connection": {
|
|
9934
|
+
"type": "string",
|
|
9935
|
+
"description": "Optional connection_name to disambiguate when the tenant has more than one database connection. Defaults to the tenant database connection."
|
|
9936
|
+
}
|
|
9937
|
+
},
|
|
9938
|
+
"additionalProperties": false
|
|
9939
|
+
}
|
|
9940
|
+
}
|
|
9941
|
+
}
|
|
9942
|
+
},
|
|
9943
|
+
"parameters": [
|
|
9944
|
+
{
|
|
9945
|
+
"schema": {
|
|
9946
|
+
"type": "string"
|
|
9947
|
+
},
|
|
9948
|
+
"in": "path",
|
|
9949
|
+
"name": "user_id",
|
|
9950
|
+
"required": true
|
|
9951
|
+
}
|
|
9952
|
+
],
|
|
9953
|
+
"security": [
|
|
9954
|
+
{
|
|
9955
|
+
"bearerAuth": []
|
|
9956
|
+
}
|
|
9957
|
+
],
|
|
9958
|
+
"responses": {
|
|
9959
|
+
"200": {
|
|
9960
|
+
"description": "Default Response",
|
|
9961
|
+
"content": {
|
|
9962
|
+
"application/json": {
|
|
9963
|
+
"schema": {
|
|
9964
|
+
"type": "object",
|
|
9965
|
+
"required": [
|
|
9966
|
+
"status",
|
|
9967
|
+
"credential_id",
|
|
9968
|
+
"ticket_id"
|
|
9969
|
+
],
|
|
9970
|
+
"properties": {
|
|
9971
|
+
"status": {
|
|
9972
|
+
"type": "string",
|
|
9973
|
+
"enum": [
|
|
9974
|
+
"sent"
|
|
9975
|
+
]
|
|
9976
|
+
},
|
|
9977
|
+
"credential_id": {
|
|
9978
|
+
"type": "string"
|
|
9979
|
+
},
|
|
9980
|
+
"ticket_id": {
|
|
9981
|
+
"type": "string"
|
|
9982
|
+
}
|
|
9983
|
+
}
|
|
9984
|
+
}
|
|
9985
|
+
}
|
|
9986
|
+
}
|
|
9987
|
+
}
|
|
9988
|
+
}
|
|
9989
|
+
}
|
|
9990
|
+
},
|
|
9918
9991
|
"/identity": {
|
|
9919
9992
|
"get": {
|
|
9920
9993
|
"operationId": "identity/list",
|