@twin.org/api-auth-entity-storage-models 0.0.3-next.33 → 0.0.3-next.35
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/es/index.js +1 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IAuthenticationAdminComponent.js.map +1 -1
- package/dist/es/models/IAuthenticationUser.js.map +1 -1
- package/dist/es/models/IAuthenticationUserSecure.js +2 -0
- package/dist/es/models/IAuthenticationUserSecure.js.map +1 -0
- package/dist/es/models/api/IAdminUserCreateRequest.js.map +1 -1
- package/dist/es/models/api/IAdminUserGetResponse.js.map +1 -1
- package/dist/es/models/api/IAdminUserUpdateRequest.js.map +1 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/models/IAuthenticationAdminComponent.d.ts +6 -4
- package/dist/types/models/IAuthenticationUser.d.ts +0 -8
- package/dist/types/models/IAuthenticationUserSecure.d.ts +18 -0
- package/dist/types/models/api/IAdminUserCreateRequest.d.ts +3 -1
- package/dist/types/models/api/IAdminUserGetResponse.d.ts +1 -1
- package/dist/types/models/api/IAdminUserUpdateRequest.d.ts +1 -1
- package/docs/changelog.md +14 -0
- package/docs/reference/index.md +1 -0
- package/docs/reference/interfaces/IAdminUserCreateRequest.md +7 -1
- package/docs/reference/interfaces/IAdminUserGetResponse.md +1 -1
- package/docs/reference/interfaces/IAdminUserUpdateRequest.md +1 -1
- package/docs/reference/interfaces/IAuthenticationAdminComponent.md +6 -6
- package/docs/reference/interfaces/IAuthenticationUser.md +4 -16
- package/docs/reference/interfaces/IAuthenticationUserSecure.md +79 -0
- package/package.json +1 -1
package/dist/es/index.js
CHANGED
|
@@ -24,4 +24,5 @@ export * from "./models/IAuthenticationComponent.js";
|
|
|
24
24
|
export * from "./models/IAuthenticationRateActionConfig.js";
|
|
25
25
|
export * from "./models/IAuthenticationRateComponent.js";
|
|
26
26
|
export * from "./models/IAuthenticationUser.js";
|
|
27
|
+
export * from "./models/IAuthenticationUserSecure.js";
|
|
27
28
|
//# sourceMappingURL=index.js.map
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,iDAAiD,CAAC;AAChE,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/api/IAdminUserCreateRequest.js\";\nexport * from \"./models/api/IAdminUserGetByIdentityRequest.js\";\nexport * from \"./models/api/IAdminUserGetRequest.js\";\nexport * from \"./models/api/IAdminUserGetResponse.js\";\nexport * from \"./models/api/IAdminUserRemoveRequest.js\";\nexport * from \"./models/api/IAdminUserUpdatePasswordRequest.js\";\nexport * from \"./models/api/IAdminUserUpdateRequest.js\";\nexport * from \"./models/api/IAuditCreateRequest.js\";\nexport * from \"./models/api/IAuditQueryRequest.js\";\nexport * from \"./models/api/IAuditQueryResponse.js\";\nexport * from \"./models/api/ILoginRequest.js\";\nexport * from \"./models/api/ILoginResponse.js\";\nexport * from \"./models/api/ILogoutRequest.js\";\nexport * from \"./models/api/IRefreshTokenRequest.js\";\nexport * from \"./models/api/IRefreshTokenResponse.js\";\nexport * from \"./models/api/IUpdatePasswordRequest.js\";\nexport * from \"./models/authAuditEvent.js\";\nexport * from \"./models/IAuthenticationAdminComponent.js\";\nexport * from \"./models/IAuthenticationAuditComponent.js\";\nexport * from \"./models/IAuthenticationAuditEntry.js\";\nexport * from \"./models/IAuthenticationComponent.js\";\nexport * from \"./models/IAuthenticationRateActionConfig.js\";\nexport * from \"./models/IAuthenticationRateComponent.js\";\nexport * from \"./models/IAuthenticationUser.js\";\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,iDAAiD,CAAC;AAChE,cAAc,yCAAyC,CAAC;AACxD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iCAAiC,CAAC;AAChD,cAAc,uCAAuC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/api/IAdminUserCreateRequest.js\";\nexport * from \"./models/api/IAdminUserGetByIdentityRequest.js\";\nexport * from \"./models/api/IAdminUserGetRequest.js\";\nexport * from \"./models/api/IAdminUserGetResponse.js\";\nexport * from \"./models/api/IAdminUserRemoveRequest.js\";\nexport * from \"./models/api/IAdminUserUpdatePasswordRequest.js\";\nexport * from \"./models/api/IAdminUserUpdateRequest.js\";\nexport * from \"./models/api/IAuditCreateRequest.js\";\nexport * from \"./models/api/IAuditQueryRequest.js\";\nexport * from \"./models/api/IAuditQueryResponse.js\";\nexport * from \"./models/api/ILoginRequest.js\";\nexport * from \"./models/api/ILoginResponse.js\";\nexport * from \"./models/api/ILogoutRequest.js\";\nexport * from \"./models/api/IRefreshTokenRequest.js\";\nexport * from \"./models/api/IRefreshTokenResponse.js\";\nexport * from \"./models/api/IUpdatePasswordRequest.js\";\nexport * from \"./models/authAuditEvent.js\";\nexport * from \"./models/IAuthenticationAdminComponent.js\";\nexport * from \"./models/IAuthenticationAuditComponent.js\";\nexport * from \"./models/IAuthenticationAuditEntry.js\";\nexport * from \"./models/IAuthenticationComponent.js\";\nexport * from \"./models/IAuthenticationRateActionConfig.js\";\nexport * from \"./models/IAuthenticationRateComponent.js\";\nexport * from \"./models/IAuthenticationUser.js\";\nexport * from \"./models/IAuthenticationUserSecure.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAuthenticationAdminComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAuthenticationUser } from \"./IAuthenticationUser.js\";\n\n/**\n * Contract definition for authentication admin component.\n */\nexport interface IAuthenticationAdminComponent extends IComponent {\n\t/**\n\t * Create a login for the user.\n\t * @param user The user to create.\n\t * @returns Nothing.\n\t */\n\tcreate(user:
|
|
1
|
+
{"version":3,"file":"IAuthenticationAdminComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IAuthenticationUser } from \"./IAuthenticationUser.js\";\n\n/**\n * Contract definition for authentication admin component.\n */\nexport interface IAuthenticationAdminComponent extends IComponent {\n\t/**\n\t * Create a login for the user.\n\t * @param user The user to create.\n\t * @returns Nothing.\n\t */\n\tcreate(user: IAuthenticationUser & { password: string }): Promise<void>;\n\n\t/**\n\t * Update a login for the user.\n\t * @param user The user to update.\n\t * @returns Nothing.\n\t */\n\tupdate(user: Partial<IAuthenticationUser>): Promise<void>;\n\n\t/**\n\t * Get a user by email.\n\t * @param email The email address of the user to get.\n\t * @returns The user details.\n\t */\n\tget(email: string): Promise<IAuthenticationUser>;\n\n\t/**\n\t * Get a user by identity.\n\t * @param identity The identity of the user to get.\n\t * @returns The user details.\n\t */\n\tgetByIdentity(identity: string): Promise<IAuthenticationUser>;\n\n\t/**\n\t * Remove a user.\n\t * @param email The email address of the user to remove.\n\t * @returns Nothing.\n\t */\n\tremove(email: string): Promise<void>;\n\n\t/**\n\t * Update the user's password.\n\t * @param email The email address of the user to update.\n\t * @param newPassword The new password for the user.\n\t * @param currentPassword The current password, optional, if supplied will check against existing.\n\t * @returns Nothing.\n\t */\n\tupdatePassword(email: string, newPassword: string, currentPassword?: string): Promise<void>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAuthenticationUser.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationUser.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Contract definition for authentication user.\n */\nexport interface IAuthenticationUser {\n\t/**\n\t * The user e-mail address.\n\t */\n\temail: string;\n\n\t/**\n\t * The
|
|
1
|
+
{"version":3,"file":"IAuthenticationUser.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationUser.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Contract definition for authentication user.\n */\nexport interface IAuthenticationUser {\n\t/**\n\t * The user e-mail address.\n\t */\n\temail: string;\n\n\t/**\n\t * The user identity.\n\t */\n\tuserIdentity: string;\n\n\t/**\n\t * The users organization.\n\t */\n\torganizationIdentity: string;\n\n\t/**\n\t * The scope assigned to the user, comma separated.\n\t */\n\tscope: string[];\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAuthenticationUserSecure.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationUserSecure.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"./IAuthenticationUser.js\";\n\n/**\n * Contract definition for authentication user.\n */\nexport interface IAuthenticationUserSecure extends IAuthenticationUser {\n\t/**\n\t * The encrypted password for the user.\n\t */\n\tpassword: string;\n\n\t/**\n\t * The salt for the password.\n\t */\n\tsalt: string;\n\n\t/**\n\t * The tenant ID associated with the user, optional in single tenant contexts.\n\t */\n\ttenantId: string;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAdminUserCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAdminUserCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"../IAuthenticationUser.js\";\n\n/**\n * Create a new user as an admin.\n */\nexport interface IAdminUserCreateRequest {\n\t/**\n\t * The body of the request.\n\t */\n\tbody:
|
|
1
|
+
{"version":3,"file":"IAdminUserCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAdminUserCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"../IAuthenticationUser.js\";\n\n/**\n * Create a new user as an admin.\n */\nexport interface IAdminUserCreateRequest {\n\t/**\n\t * The body of the request.\n\t */\n\tbody: IAuthenticationUser & { password: string };\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAdminUserGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAdminUserGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"../IAuthenticationUser.js\";\n\n/**\n * Get a user as an admin.\n */\nexport interface IAdminUserGetResponse {\n\t/**\n\t * The body of the request.\n\t */\n\tbody:
|
|
1
|
+
{"version":3,"file":"IAdminUserGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAdminUserGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"../IAuthenticationUser.js\";\n\n/**\n * Get a user as an admin.\n */\nexport interface IAdminUserGetResponse {\n\t/**\n\t * The body of the request.\n\t */\n\tbody: IAuthenticationUser;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAdminUserUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAdminUserUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"../IAuthenticationUser.js\";\n\n/**\n * Update a user as an admin.\n */\nexport interface IAdminUserUpdateRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The user email.\n\t\t */\n\t\temail: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: Partial<Omit<IAuthenticationUser, \"email\"
|
|
1
|
+
{"version":3,"file":"IAdminUserUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAdminUserUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationUser } from \"../IAuthenticationUser.js\";\n\n/**\n * Update a user as an admin.\n */\nexport interface IAdminUserUpdateRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The user email.\n\t\t */\n\t\temail: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: Partial<Omit<IAuthenticationUser, \"email\">>;\n}\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -22,3 +22,4 @@ export * from "./models/IAuthenticationComponent.js";
|
|
|
22
22
|
export * from "./models/IAuthenticationRateActionConfig.js";
|
|
23
23
|
export * from "./models/IAuthenticationRateComponent.js";
|
|
24
24
|
export * from "./models/IAuthenticationUser.js";
|
|
25
|
+
export * from "./models/IAuthenticationUserSecure.js";
|
|
@@ -9,25 +9,27 @@ export interface IAuthenticationAdminComponent extends IComponent {
|
|
|
9
9
|
* @param user The user to create.
|
|
10
10
|
* @returns Nothing.
|
|
11
11
|
*/
|
|
12
|
-
create(user:
|
|
12
|
+
create(user: IAuthenticationUser & {
|
|
13
|
+
password: string;
|
|
14
|
+
}): Promise<void>;
|
|
13
15
|
/**
|
|
14
16
|
* Update a login for the user.
|
|
15
17
|
* @param user The user to update.
|
|
16
18
|
* @returns Nothing.
|
|
17
19
|
*/
|
|
18
|
-
update(user: Partial<
|
|
20
|
+
update(user: Partial<IAuthenticationUser>): Promise<void>;
|
|
19
21
|
/**
|
|
20
22
|
* Get a user by email.
|
|
21
23
|
* @param email The email address of the user to get.
|
|
22
24
|
* @returns The user details.
|
|
23
25
|
*/
|
|
24
|
-
get(email: string): Promise<
|
|
26
|
+
get(email: string): Promise<IAuthenticationUser>;
|
|
25
27
|
/**
|
|
26
28
|
* Get a user by identity.
|
|
27
29
|
* @param identity The identity of the user to get.
|
|
28
30
|
* @returns The user details.
|
|
29
31
|
*/
|
|
30
|
-
getByIdentity(identity: string): Promise<
|
|
32
|
+
getByIdentity(identity: string): Promise<IAuthenticationUser>;
|
|
31
33
|
/**
|
|
32
34
|
* Remove a user.
|
|
33
35
|
* @param email The email address of the user to remove.
|
|
@@ -6,14 +6,6 @@ export interface IAuthenticationUser {
|
|
|
6
6
|
* The user e-mail address.
|
|
7
7
|
*/
|
|
8
8
|
email: string;
|
|
9
|
-
/**
|
|
10
|
-
* The encrypted password for the user.
|
|
11
|
-
*/
|
|
12
|
-
password: string;
|
|
13
|
-
/**
|
|
14
|
-
* The salt for the password.
|
|
15
|
-
*/
|
|
16
|
-
salt: string;
|
|
17
9
|
/**
|
|
18
10
|
* The user identity.
|
|
19
11
|
*/
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { IAuthenticationUser } from "./IAuthenticationUser.js";
|
|
2
|
+
/**
|
|
3
|
+
* Contract definition for authentication user.
|
|
4
|
+
*/
|
|
5
|
+
export interface IAuthenticationUserSecure extends IAuthenticationUser {
|
|
6
|
+
/**
|
|
7
|
+
* The encrypted password for the user.
|
|
8
|
+
*/
|
|
9
|
+
password: string;
|
|
10
|
+
/**
|
|
11
|
+
* The salt for the password.
|
|
12
|
+
*/
|
|
13
|
+
salt: string;
|
|
14
|
+
/**
|
|
15
|
+
* The tenant ID associated with the user, optional in single tenant contexts.
|
|
16
|
+
*/
|
|
17
|
+
tenantId: string;
|
|
18
|
+
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.35](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.34...api-auth-entity-storage-models-v0.0.3-next.35) (2026-05-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* user partitioning ([#126](https://github.com/iotaledger/twin-api/issues/126)) ([6bf0da3](https://github.com/iotaledger/twin-api/commit/6bf0da3c42406c9838e80e0ddd6b21f5c64aac90))
|
|
9
|
+
|
|
10
|
+
## [0.0.3-next.34](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.33...api-auth-entity-storage-models-v0.0.3-next.34) (2026-05-19)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* update dependencies ([32b8cd2](https://github.com/iotaledger/twin-api/commit/32b8cd20353119dd1998e293d54063cf4d9ecc29))
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.33](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.32...api-auth-entity-storage-models-v0.0.3-next.33) (2026-05-11)
|
|
4
18
|
|
|
5
19
|
|
package/docs/reference/index.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
- [IAuthenticationRateActionConfig](interfaces/IAuthenticationRateActionConfig.md)
|
|
10
10
|
- [IAuthenticationRateComponent](interfaces/IAuthenticationRateComponent.md)
|
|
11
11
|
- [IAuthenticationUser](interfaces/IAuthenticationUser.md)
|
|
12
|
+
- [IAuthenticationUserSecure](interfaces/IAuthenticationUserSecure.md)
|
|
12
13
|
- [IAdminUserCreateRequest](interfaces/IAdminUserCreateRequest.md)
|
|
13
14
|
- [IAdminUserGetByIdentityRequest](interfaces/IAdminUserGetByIdentityRequest.md)
|
|
14
15
|
- [IAdminUserGetRequest](interfaces/IAdminUserGetRequest.md)
|
|
@@ -6,6 +6,12 @@ Create a new user as an admin.
|
|
|
6
6
|
|
|
7
7
|
### body {#body}
|
|
8
8
|
|
|
9
|
-
> **body**:
|
|
9
|
+
> **body**: [`IAuthenticationUser`](IAuthenticationUser.md) & `object`
|
|
10
10
|
|
|
11
11
|
The body of the request.
|
|
12
|
+
|
|
13
|
+
#### Type Declaration
|
|
14
|
+
|
|
15
|
+
##### password
|
|
16
|
+
|
|
17
|
+
> **password**: `string`
|
|
@@ -20,6 +20,6 @@ The user email.
|
|
|
20
20
|
|
|
21
21
|
### body {#body}
|
|
22
22
|
|
|
23
|
-
> **body**: `Partial`\<`Omit`\<[`IAuthenticationUser`](IAuthenticationUser.md), `"email"
|
|
23
|
+
> **body**: `Partial`\<`Omit`\<[`IAuthenticationUser`](IAuthenticationUser.md), `"email"`\>\>
|
|
24
24
|
|
|
25
25
|
The body of the request.
|
|
@@ -18,7 +18,7 @@ Create a login for the user.
|
|
|
18
18
|
|
|
19
19
|
##### user
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
[`IAuthenticationUser`](IAuthenticationUser.md) & `object`
|
|
22
22
|
|
|
23
23
|
The user to create.
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ Update a login for the user.
|
|
|
40
40
|
|
|
41
41
|
##### user
|
|
42
42
|
|
|
43
|
-
`Partial
|
|
43
|
+
`Partial`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
|
|
44
44
|
|
|
45
45
|
The user to update.
|
|
46
46
|
|
|
@@ -54,7 +54,7 @@ Nothing.
|
|
|
54
54
|
|
|
55
55
|
### get() {#get}
|
|
56
56
|
|
|
57
|
-
> **get**(`email`): `Promise
|
|
57
|
+
> **get**(`email`): `Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
|
|
58
58
|
|
|
59
59
|
Get a user by email.
|
|
60
60
|
|
|
@@ -68,7 +68,7 @@ The email address of the user to get.
|
|
|
68
68
|
|
|
69
69
|
#### Returns
|
|
70
70
|
|
|
71
|
-
`Promise
|
|
71
|
+
`Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
|
|
72
72
|
|
|
73
73
|
The user details.
|
|
74
74
|
|
|
@@ -76,7 +76,7 @@ The user details.
|
|
|
76
76
|
|
|
77
77
|
### getByIdentity() {#getbyidentity}
|
|
78
78
|
|
|
79
|
-
> **getByIdentity**(`identity`): `Promise
|
|
79
|
+
> **getByIdentity**(`identity`): `Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
|
|
80
80
|
|
|
81
81
|
Get a user by identity.
|
|
82
82
|
|
|
@@ -90,7 +90,7 @@ The identity of the user to get.
|
|
|
90
90
|
|
|
91
91
|
#### Returns
|
|
92
92
|
|
|
93
|
-
`Promise
|
|
93
|
+
`Promise`\<[`IAuthenticationUser`](IAuthenticationUser.md)\>
|
|
94
94
|
|
|
95
95
|
The user details.
|
|
96
96
|
|
|
@@ -2,6 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Contract definition for authentication user.
|
|
4
4
|
|
|
5
|
+
## Extended by
|
|
6
|
+
|
|
7
|
+
- [`IAuthenticationUserSecure`](IAuthenticationUserSecure.md)
|
|
8
|
+
|
|
5
9
|
## Properties
|
|
6
10
|
|
|
7
11
|
### email {#email}
|
|
@@ -12,22 +16,6 @@ The user e-mail address.
|
|
|
12
16
|
|
|
13
17
|
***
|
|
14
18
|
|
|
15
|
-
### password {#password}
|
|
16
|
-
|
|
17
|
-
> **password**: `string`
|
|
18
|
-
|
|
19
|
-
The encrypted password for the user.
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### salt {#salt}
|
|
24
|
-
|
|
25
|
-
> **salt**: `string`
|
|
26
|
-
|
|
27
|
-
The salt for the password.
|
|
28
|
-
|
|
29
|
-
***
|
|
30
|
-
|
|
31
19
|
### userIdentity {#useridentity}
|
|
32
20
|
|
|
33
21
|
> **userIdentity**: `string`
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Interface: IAuthenticationUserSecure
|
|
2
|
+
|
|
3
|
+
Contract definition for authentication user.
|
|
4
|
+
|
|
5
|
+
## Extends
|
|
6
|
+
|
|
7
|
+
- [`IAuthenticationUser`](IAuthenticationUser.md)
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### email {#email}
|
|
12
|
+
|
|
13
|
+
> **email**: `string`
|
|
14
|
+
|
|
15
|
+
The user e-mail address.
|
|
16
|
+
|
|
17
|
+
#### Inherited from
|
|
18
|
+
|
|
19
|
+
[`IAuthenticationUser`](IAuthenticationUser.md).[`email`](IAuthenticationUser.md#email)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### userIdentity {#useridentity}
|
|
24
|
+
|
|
25
|
+
> **userIdentity**: `string`
|
|
26
|
+
|
|
27
|
+
The user identity.
|
|
28
|
+
|
|
29
|
+
#### Inherited from
|
|
30
|
+
|
|
31
|
+
[`IAuthenticationUser`](IAuthenticationUser.md).[`userIdentity`](IAuthenticationUser.md#useridentity)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### organizationIdentity {#organizationidentity}
|
|
36
|
+
|
|
37
|
+
> **organizationIdentity**: `string`
|
|
38
|
+
|
|
39
|
+
The users organization.
|
|
40
|
+
|
|
41
|
+
#### Inherited from
|
|
42
|
+
|
|
43
|
+
[`IAuthenticationUser`](IAuthenticationUser.md).[`organizationIdentity`](IAuthenticationUser.md#organizationidentity)
|
|
44
|
+
|
|
45
|
+
***
|
|
46
|
+
|
|
47
|
+
### scope {#scope}
|
|
48
|
+
|
|
49
|
+
> **scope**: `string`[]
|
|
50
|
+
|
|
51
|
+
The scope assigned to the user, comma separated.
|
|
52
|
+
|
|
53
|
+
#### Inherited from
|
|
54
|
+
|
|
55
|
+
[`IAuthenticationUser`](IAuthenticationUser.md).[`scope`](IAuthenticationUser.md#scope)
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### password {#password}
|
|
60
|
+
|
|
61
|
+
> **password**: `string`
|
|
62
|
+
|
|
63
|
+
The encrypted password for the user.
|
|
64
|
+
|
|
65
|
+
***
|
|
66
|
+
|
|
67
|
+
### salt {#salt}
|
|
68
|
+
|
|
69
|
+
> **salt**: `string`
|
|
70
|
+
|
|
71
|
+
The salt for the password.
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### tenantId {#tenantid}
|
|
76
|
+
|
|
77
|
+
> **tenantId**: `string`
|
|
78
|
+
|
|
79
|
+
The tenant ID associated with the user, optional in single tenant contexts.
|
package/package.json
CHANGED