@twin.org/api-auth-entity-storage-models 0.9.1-next.3 → 0.9.1-next.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/es/index.js +4 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IAuthenticationAuditComponent.js.map +1 -1
- package/dist/es/models/api/IAuditGetRequest.js +4 -0
- package/dist/es/models/api/IAuditGetRequest.js.map +1 -0
- package/dist/es/models/api/IAuditGetResponse.js +2 -0
- package/dist/es/models/api/IAuditGetResponse.js.map +1 -0
- package/dist/es/models/api/IAuditRemoveRequest.js +4 -0
- package/dist/es/models/api/IAuditRemoveRequest.js.map +1 -0
- package/dist/es/models/api/IAuditUpdateRequest.js +2 -0
- package/dist/es/models/api/IAuditUpdateRequest.js.map +1 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/models/IAuthenticationAuditComponent.d.ts +19 -0
- package/dist/types/models/api/IAuditGetRequest.d.ts +14 -0
- package/dist/types/models/api/IAuditGetResponse.d.ts +10 -0
- package/dist/types/models/api/IAuditRemoveRequest.d.ts +14 -0
- package/dist/types/models/api/IAuditUpdateRequest.d.ts +19 -0
- package/docs/changelog.md +14 -0
- package/docs/reference/index.md +4 -0
- package/docs/reference/interfaces/IAuditGetRequest.md +17 -0
- package/docs/reference/interfaces/IAuditGetResponse.md +11 -0
- package/docs/reference/interfaces/IAuditRemoveRequest.md +17 -0
- package/docs/reference/interfaces/IAuditUpdateRequest.md +25 -0
- package/docs/reference/interfaces/IAuthenticationAuditComponent.md +72 -0
- package/package.json +1 -1
package/dist/es/index.js
CHANGED
|
@@ -8,8 +8,12 @@ export * from "./models/api/IAdminUserRemoveRequest.js";
|
|
|
8
8
|
export * from "./models/api/IAdminUserUpdatePasswordRequest.js";
|
|
9
9
|
export * from "./models/api/IAdminUserUpdateRequest.js";
|
|
10
10
|
export * from "./models/api/IAuditCreateRequest.js";
|
|
11
|
+
export * from "./models/api/IAuditGetRequest.js";
|
|
12
|
+
export * from "./models/api/IAuditGetResponse.js";
|
|
11
13
|
export * from "./models/api/IAuditQueryRequest.js";
|
|
12
14
|
export * from "./models/api/IAuditQueryResponse.js";
|
|
15
|
+
export * from "./models/api/IAuditRemoveRequest.js";
|
|
16
|
+
export * from "./models/api/IAuditUpdateRequest.js";
|
|
13
17
|
export * from "./models/api/ILoginRequest.js";
|
|
14
18
|
export * from "./models/api/ILoginResponse.js";
|
|
15
19
|
export * from "./models/api/ILogoutRequest.js";
|
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;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
|
+
{"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,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,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/IAuditGetRequest.js\";\nexport * from \"./models/api/IAuditGetResponse.js\";\nexport * from \"./models/api/IAuditQueryRequest.js\";\nexport * from \"./models/api/IAuditQueryResponse.js\";\nexport * from \"./models/api/IAuditRemoveRequest.js\";\nexport * from \"./models/api/IAuditUpdateRequest.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":"IAuthenticationAuditComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAuditComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { AuthAuditEvent } from \"./authAuditEvent.js\";\nimport type { IAuthenticationAuditEntry } from \"./IAuthenticationAuditEntry.js\";\n\n/**\n * Contract definition for authentication audit component.\n */\nexport interface IAuthenticationAuditComponent extends IComponent {\n\t/**\n\t * Create a new audit entry.\n\t * @param entry The audit entry to be logged.\n\t * @returns The unique identifier of the created audit entry.\n\t */\n\tcreate(entry: Omit<IAuthenticationAuditEntry, \"id\" | \"dateCreated\">): Promise<string>;\n\n\t/**\n\t * Query the audit entries.\n\t * @param options The query options.\n\t * @param options.actorId The actor identifier to filter the audit entries, optional.\n\t * @param options.organizationId The organization identifier to filter the audit entries, optional.\n\t * @param options.tenantId The tenant identifier to filter the audit entries, optional.\n\t * @param options.nodeId The node identifier to filter the audit entries, optional.\n\t * @param options.event The audit event to filter the audit entries, optional.\n\t * @param options.startDate The start date to filter the audit entries, optional.\n\t * @param options.endDate The end date to filter the audit entries, optional.\n\t * @param cursor The cursor for pagination.\n\t * @param limit The maximum number of entries to return.\n\t * @returns The audit entries.\n\t */\n\tquery(\n\t\toptions?: {\n\t\t\tactorId?: string;\n\t\t\torganizationId?: string;\n\t\t\ttenantId?: string;\n\t\t\tnodeId?: string;\n\t\t\tevent?: AuthAuditEvent | string;\n\t\t\tstartDate?: string;\n\t\t\tendDate?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAuthenticationAuditEntry[];\n\t\tcursor?: string;\n\t}>;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IAuthenticationAuditComponent.js","sourceRoot":"","sources":["../../../src/models/IAuthenticationAuditComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { AuthAuditEvent } from \"./authAuditEvent.js\";\nimport type { IAuthenticationAuditEntry } from \"./IAuthenticationAuditEntry.js\";\n\n/**\n * Contract definition for authentication audit component.\n */\nexport interface IAuthenticationAuditComponent extends IComponent {\n\t/**\n\t * Create a new audit entry.\n\t * @param entry The audit entry to be logged.\n\t * @returns The unique identifier of the created audit entry.\n\t */\n\tcreate(entry: Omit<IAuthenticationAuditEntry, \"id\" | \"dateCreated\">): Promise<string>;\n\n\t/**\n\t * Get an audit entry by id.\n\t * @param id The unique identifier of the audit entry.\n\t * @returns The audit entry.\n\t */\n\tget(id: string): Promise<IAuthenticationAuditEntry>;\n\n\t/**\n\t * Update an audit entry.\n\t * @param id The unique identifier of the audit entry to update.\n\t * @param entry The fields to update on the audit entry.\n\t * @returns A promise that resolves when the audit entry has been updated.\n\t */\n\tupdate(\n\t\tid: string,\n\t\tentry: Partial<Omit<IAuthenticationAuditEntry, \"id\" | \"dateCreated\">>\n\t): Promise<void>;\n\n\t/**\n\t * Remove an audit entry.\n\t * @param id The unique identifier of the audit entry to remove.\n\t * @returns A promise that resolves when the audit entry has been removed.\n\t */\n\tremove(id: string): Promise<void>;\n\n\t/**\n\t * Query the audit entries.\n\t * @param options The query options.\n\t * @param options.actorId The actor identifier to filter the audit entries, optional.\n\t * @param options.organizationId The organization identifier to filter the audit entries, optional.\n\t * @param options.tenantId The tenant identifier to filter the audit entries, optional.\n\t * @param options.nodeId The node identifier to filter the audit entries, optional.\n\t * @param options.event The audit event to filter the audit entries, optional.\n\t * @param options.startDate The start date to filter the audit entries, optional.\n\t * @param options.endDate The end date to filter the audit entries, optional.\n\t * @param cursor The cursor for pagination.\n\t * @param limit The maximum number of entries to return.\n\t * @returns The audit entries.\n\t */\n\tquery(\n\t\toptions?: {\n\t\t\tactorId?: string;\n\t\t\torganizationId?: string;\n\t\t\ttenantId?: string;\n\t\t\tnodeId?: string;\n\t\t\tevent?: AuthAuditEvent | string;\n\t\t\tstartDate?: string;\n\t\t\tendDate?: string;\n\t\t},\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAuthenticationAuditEntry[];\n\t\tcursor?: string;\n\t}>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAuditGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get an authentication audit entry by id.\n */\nexport interface IAuditGetRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The audit entry id.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAuditGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationAuditEntry } from \"../IAuthenticationAuditEntry.js\";\n\n/**\n * Response from getting an authentication audit entry.\n */\nexport interface IAuditGetResponse {\n\t/**\n\t * The response body.\n\t */\n\tbody: IAuthenticationAuditEntry;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAuditRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove an authentication audit entry.\n */\nexport interface IAuditRemoveRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The audit entry id.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IAuditUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IAuthenticationAuditEntry } from \"../IAuthenticationAuditEntry.js\";\n\n/**\n * Update an authentication audit entry.\n */\nexport interface IAuditUpdateRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The audit entry id.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: Partial<Omit<IAuthenticationAuditEntry, \"id\" | \"dateCreated\">>;\n}\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -6,8 +6,12 @@ export * from "./models/api/IAdminUserRemoveRequest.js";
|
|
|
6
6
|
export * from "./models/api/IAdminUserUpdatePasswordRequest.js";
|
|
7
7
|
export * from "./models/api/IAdminUserUpdateRequest.js";
|
|
8
8
|
export * from "./models/api/IAuditCreateRequest.js";
|
|
9
|
+
export * from "./models/api/IAuditGetRequest.js";
|
|
10
|
+
export * from "./models/api/IAuditGetResponse.js";
|
|
9
11
|
export * from "./models/api/IAuditQueryRequest.js";
|
|
10
12
|
export * from "./models/api/IAuditQueryResponse.js";
|
|
13
|
+
export * from "./models/api/IAuditRemoveRequest.js";
|
|
14
|
+
export * from "./models/api/IAuditUpdateRequest.js";
|
|
11
15
|
export * from "./models/api/ILoginRequest.js";
|
|
12
16
|
export * from "./models/api/ILoginResponse.js";
|
|
13
17
|
export * from "./models/api/ILogoutRequest.js";
|
|
@@ -11,6 +11,25 @@ export interface IAuthenticationAuditComponent extends IComponent {
|
|
|
11
11
|
* @returns The unique identifier of the created audit entry.
|
|
12
12
|
*/
|
|
13
13
|
create(entry: Omit<IAuthenticationAuditEntry, "id" | "dateCreated">): Promise<string>;
|
|
14
|
+
/**
|
|
15
|
+
* Get an audit entry by id.
|
|
16
|
+
* @param id The unique identifier of the audit entry.
|
|
17
|
+
* @returns The audit entry.
|
|
18
|
+
*/
|
|
19
|
+
get(id: string): Promise<IAuthenticationAuditEntry>;
|
|
20
|
+
/**
|
|
21
|
+
* Update an audit entry.
|
|
22
|
+
* @param id The unique identifier of the audit entry to update.
|
|
23
|
+
* @param entry The fields to update on the audit entry.
|
|
24
|
+
* @returns A promise that resolves when the audit entry has been updated.
|
|
25
|
+
*/
|
|
26
|
+
update(id: string, entry: Partial<Omit<IAuthenticationAuditEntry, "id" | "dateCreated">>): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Remove an audit entry.
|
|
29
|
+
* @param id The unique identifier of the audit entry to remove.
|
|
30
|
+
* @returns A promise that resolves when the audit entry has been removed.
|
|
31
|
+
*/
|
|
32
|
+
remove(id: string): Promise<void>;
|
|
14
33
|
/**
|
|
15
34
|
* Query the audit entries.
|
|
16
35
|
* @param options The query options.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
|
|
2
|
+
/**
|
|
3
|
+
* Response from getting an authentication audit entry.
|
|
4
|
+
*/
|
|
5
|
+
export interface IAuditGetResponse {
|
|
6
|
+
/**
|
|
7
|
+
* The response body.
|
|
8
|
+
*/
|
|
9
|
+
body: IAuthenticationAuditEntry;
|
|
10
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { IAuthenticationAuditEntry } from "../IAuthenticationAuditEntry.js";
|
|
2
|
+
/**
|
|
3
|
+
* Update an authentication audit entry.
|
|
4
|
+
*/
|
|
5
|
+
export interface IAuditUpdateRequest {
|
|
6
|
+
/**
|
|
7
|
+
* The path parameters for the request.
|
|
8
|
+
*/
|
|
9
|
+
pathParams: {
|
|
10
|
+
/**
|
|
11
|
+
* The audit entry id.
|
|
12
|
+
*/
|
|
13
|
+
id: string;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* The body of the request.
|
|
17
|
+
*/
|
|
18
|
+
body: Partial<Omit<IAuthenticationAuditEntry, "id" | "dateCreated">>;
|
|
19
|
+
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.1-next.5](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.9.1-next.4...api-auth-entity-storage-models-v0.9.1-next.5) (2026-06-30)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **api-auth-entity-storage-models:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
## [0.9.1-next.4](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.9.1-next.3...api-auth-entity-storage-models-v0.9.1-next.4) (2026-06-30)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* improved rest handling ([#211](https://github.com/iotaledger/twin-api/issues/211)) ([12c50ea](https://github.com/iotaledger/twin-api/commit/12c50ea7655276eed7a73d311ac5286476c98201))
|
|
16
|
+
|
|
3
17
|
## [0.9.1-next.3](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.9.1-next.2...api-auth-entity-storage-models-v0.9.1-next.3) (2026-06-29)
|
|
4
18
|
|
|
5
19
|
|
package/docs/reference/index.md
CHANGED
|
@@ -18,8 +18,12 @@
|
|
|
18
18
|
- [IAdminUserUpdatePasswordRequest](interfaces/IAdminUserUpdatePasswordRequest.md)
|
|
19
19
|
- [IAdminUserUpdateRequest](interfaces/IAdminUserUpdateRequest.md)
|
|
20
20
|
- [IAuditCreateRequest](interfaces/IAuditCreateRequest.md)
|
|
21
|
+
- [IAuditGetRequest](interfaces/IAuditGetRequest.md)
|
|
22
|
+
- [IAuditGetResponse](interfaces/IAuditGetResponse.md)
|
|
21
23
|
- [IAuditQueryRequest](interfaces/IAuditQueryRequest.md)
|
|
22
24
|
- [IAuditQueryResponse](interfaces/IAuditQueryResponse.md)
|
|
25
|
+
- [IAuditRemoveRequest](interfaces/IAuditRemoveRequest.md)
|
|
26
|
+
- [IAuditUpdateRequest](interfaces/IAuditUpdateRequest.md)
|
|
23
27
|
- [ILoginRequest](interfaces/ILoginRequest.md)
|
|
24
28
|
- [ILoginResponse](interfaces/ILoginResponse.md)
|
|
25
29
|
- [ILogoutRequest](interfaces/ILogoutRequest.md)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Interface: IAuditGetRequest
|
|
2
|
+
|
|
3
|
+
Get an authentication audit entry by id.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### pathParams {#pathparams}
|
|
8
|
+
|
|
9
|
+
> **pathParams**: `object`
|
|
10
|
+
|
|
11
|
+
The path parameters for the request.
|
|
12
|
+
|
|
13
|
+
#### id
|
|
14
|
+
|
|
15
|
+
> **id**: `string`
|
|
16
|
+
|
|
17
|
+
The audit entry id.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Interface: IAuditRemoveRequest
|
|
2
|
+
|
|
3
|
+
Remove an authentication audit entry.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### pathParams {#pathparams}
|
|
8
|
+
|
|
9
|
+
> **pathParams**: `object`
|
|
10
|
+
|
|
11
|
+
The path parameters for the request.
|
|
12
|
+
|
|
13
|
+
#### id
|
|
14
|
+
|
|
15
|
+
> **id**: `string`
|
|
16
|
+
|
|
17
|
+
The audit entry id.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Interface: IAuditUpdateRequest
|
|
2
|
+
|
|
3
|
+
Update an authentication audit entry.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### pathParams {#pathparams}
|
|
8
|
+
|
|
9
|
+
> **pathParams**: `object`
|
|
10
|
+
|
|
11
|
+
The path parameters for the request.
|
|
12
|
+
|
|
13
|
+
#### id
|
|
14
|
+
|
|
15
|
+
> **id**: `string`
|
|
16
|
+
|
|
17
|
+
The audit entry id.
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### body {#body}
|
|
22
|
+
|
|
23
|
+
> **body**: `Partial`\<`Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>\>
|
|
24
|
+
|
|
25
|
+
The body of the request.
|
|
@@ -30,6 +30,78 @@ The unique identifier of the created audit entry.
|
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
33
|
+
### get() {#get}
|
|
34
|
+
|
|
35
|
+
> **get**(`id`): `Promise`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)\>
|
|
36
|
+
|
|
37
|
+
Get an audit entry by id.
|
|
38
|
+
|
|
39
|
+
#### Parameters
|
|
40
|
+
|
|
41
|
+
##### id
|
|
42
|
+
|
|
43
|
+
`string`
|
|
44
|
+
|
|
45
|
+
The unique identifier of the audit entry.
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
`Promise`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)\>
|
|
50
|
+
|
|
51
|
+
The audit entry.
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### update() {#update}
|
|
56
|
+
|
|
57
|
+
> **update**(`id`, `entry`): `Promise`\<`void`\>
|
|
58
|
+
|
|
59
|
+
Update an audit entry.
|
|
60
|
+
|
|
61
|
+
#### Parameters
|
|
62
|
+
|
|
63
|
+
##### id
|
|
64
|
+
|
|
65
|
+
`string`
|
|
66
|
+
|
|
67
|
+
The unique identifier of the audit entry to update.
|
|
68
|
+
|
|
69
|
+
##### entry
|
|
70
|
+
|
|
71
|
+
`Partial`\<`Omit`\<[`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md), `"id"` \| `"dateCreated"`\>\>
|
|
72
|
+
|
|
73
|
+
The fields to update on the audit entry.
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
`Promise`\<`void`\>
|
|
78
|
+
|
|
79
|
+
A promise that resolves when the audit entry has been updated.
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### remove() {#remove}
|
|
84
|
+
|
|
85
|
+
> **remove**(`id`): `Promise`\<`void`\>
|
|
86
|
+
|
|
87
|
+
Remove an audit entry.
|
|
88
|
+
|
|
89
|
+
#### Parameters
|
|
90
|
+
|
|
91
|
+
##### id
|
|
92
|
+
|
|
93
|
+
`string`
|
|
94
|
+
|
|
95
|
+
The unique identifier of the audit entry to remove.
|
|
96
|
+
|
|
97
|
+
#### Returns
|
|
98
|
+
|
|
99
|
+
`Promise`\<`void`\>
|
|
100
|
+
|
|
101
|
+
A promise that resolves when the audit entry has been removed.
|
|
102
|
+
|
|
103
|
+
***
|
|
104
|
+
|
|
33
105
|
### query() {#query}
|
|
34
106
|
|
|
35
107
|
> **query**(`options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuthenticationAuditEntry`](IAuthenticationAuditEntry.md)[]; `cursor?`: `string`; \}\>
|
package/package.json
CHANGED