@twin.org/identity-service 0.9.2-next.6 → 0.9.2-next.7
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/identityProfileRoutes.js +278 -1
- package/dist/es/identityProfileRoutes.js.map +1 -1
- package/dist/es/identityProfileService.js +25 -1
- package/dist/es/identityProfileService.js.map +1 -1
- package/dist/types/identityProfileRoutes.d.ts +33 -1
- package/dist/types/identityProfileService.d.ts +29 -0
- package/docs/changelog.md +16 -0
- package/docs/open-api/spec.json +681 -0
- package/docs/reference/classes/IdentityProfileService.md +56 -0
- package/docs/reference/functions/identitiesAdminList.md +31 -0
- package/docs/reference/functions/identityProfileAdminGet.md +31 -0
- package/docs/reference/functions/identityProfileAdminRemove.md +31 -0
- package/docs/reference/functions/identityProfileAdminUpdate.md +31 -0
- package/docs/reference/index.md +4 -0
- package/locales/en.json +2 -1
- package/package.json +2 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type IHttpRequestContext, type INoContentRequest, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
|
|
2
|
-
import type { IIdentityProfileCreateRequest, IIdentityProfileGetPublicRequest, IIdentityProfileGetPublicResponse, IIdentityProfileGetRequest, IIdentityProfileGetResponse, IIdentityProfileListRequest, IIdentityProfileListResponse, IIdentityProfileUpdateRequest } from "@twin.org/identity-models";
|
|
2
|
+
import type { IIdentityProfileAdminGetRequest, IIdentityProfileAdminListRequest, IIdentityProfileAdminListResponse, IIdentityProfileAdminRemoveRequest, IIdentityProfileAdminUpdateRequest, IIdentityProfileCreateRequest, IIdentityProfileGetPublicRequest, IIdentityProfileGetPublicResponse, IIdentityProfileGetRequest, IIdentityProfileGetResponse, IIdentityProfileListRequest, IIdentityProfileListResponse, IIdentityProfileUpdateRequest } from "@twin.org/identity-models";
|
|
3
3
|
/**
|
|
4
4
|
* The tag to associate with the routes.
|
|
5
5
|
*/
|
|
@@ -27,6 +27,14 @@ export declare function identityProfileCreate(httpRequestContext: IHttpRequestCo
|
|
|
27
27
|
* @returns The response object with additional http response properties.
|
|
28
28
|
*/
|
|
29
29
|
export declare function identityGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileGetRequest): Promise<IIdentityProfileGetResponse>;
|
|
30
|
+
/**
|
|
31
|
+
* Get the identity profile of another user as an admin.
|
|
32
|
+
* @param httpRequestContext The request context for the API.
|
|
33
|
+
* @param componentName The name of the component to use in the routes stored in the ComponentFactory.
|
|
34
|
+
* @param request The request.
|
|
35
|
+
* @returns The response object with additional http response properties.
|
|
36
|
+
*/
|
|
37
|
+
export declare function identityProfileAdminGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileAdminGetRequest): Promise<IIdentityProfileGetResponse>;
|
|
30
38
|
/**
|
|
31
39
|
* Get the identity public profile.
|
|
32
40
|
* @param httpRequestContext The request context for the API.
|
|
@@ -43,6 +51,14 @@ export declare function identityGetPublic(httpRequestContext: IHttpRequestContex
|
|
|
43
51
|
* @returns The response object with additional http response properties.
|
|
44
52
|
*/
|
|
45
53
|
export declare function identityProfileUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileUpdateRequest): Promise<INoContentResponse>;
|
|
54
|
+
/**
|
|
55
|
+
* Update the identity profile of another user as an admin.
|
|
56
|
+
* @param httpRequestContext The request context for the API.
|
|
57
|
+
* @param componentName The name of the component to use in the routes stored in the ComponentFactory.
|
|
58
|
+
* @param request The request.
|
|
59
|
+
* @returns The response object with additional http response properties.
|
|
60
|
+
*/
|
|
61
|
+
export declare function identityProfileAdminUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileAdminUpdateRequest): Promise<INoContentResponse>;
|
|
46
62
|
/**
|
|
47
63
|
* Remove an identity profile.
|
|
48
64
|
* @param httpRequestContext The request context for the API.
|
|
@@ -51,6 +67,14 @@ export declare function identityProfileUpdate(httpRequestContext: IHttpRequestCo
|
|
|
51
67
|
* @returns The response object with additional http response properties.
|
|
52
68
|
*/
|
|
53
69
|
export declare function identityProfileRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise<INoContentResponse>;
|
|
70
|
+
/**
|
|
71
|
+
* Remove the identity profile of another user as an admin.
|
|
72
|
+
* @param httpRequestContext The request context for the API.
|
|
73
|
+
* @param componentName The name of the component to use in the routes stored in the ComponentFactory.
|
|
74
|
+
* @param request The request.
|
|
75
|
+
* @returns The response object with additional http response properties.
|
|
76
|
+
*/
|
|
77
|
+
export declare function identityProfileAdminRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileAdminRemoveRequest): Promise<INoContentResponse>;
|
|
54
78
|
/**
|
|
55
79
|
* Get the list of organizations.
|
|
56
80
|
* @param httpRequestContext The request context for the API.
|
|
@@ -59,3 +83,11 @@ export declare function identityProfileRemove(httpRequestContext: IHttpRequestCo
|
|
|
59
83
|
* @returns The response object with additional http response properties.
|
|
60
84
|
*/
|
|
61
85
|
export declare function identitiesList(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileListRequest): Promise<IIdentityProfileListResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* Get the list of identity profiles including private properties as an admin.
|
|
88
|
+
* @param httpRequestContext The request context for the API.
|
|
89
|
+
* @param componentName The name of the component to use in the routes stored in the ComponentFactory.
|
|
90
|
+
* @param request The request.
|
|
91
|
+
* @returns The response object with additional http response properties.
|
|
92
|
+
*/
|
|
93
|
+
export declare function identitiesAdminList(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProfileAdminListRequest): Promise<IIdentityProfileAdminListResponse>;
|
|
@@ -72,6 +72,35 @@ export declare class IdentityProfileService<T extends IJsonLdDocument = IJsonLdD
|
|
|
72
72
|
propertyName: string;
|
|
73
73
|
propertyValue: unknown;
|
|
74
74
|
}[], publicPropertyNames?: (keyof T)[], cursor?: string, limit?: number): Promise<{
|
|
75
|
+
/**
|
|
76
|
+
* The identities.
|
|
77
|
+
*/
|
|
78
|
+
items: {
|
|
79
|
+
identity: string;
|
|
80
|
+
publicProfile?: Partial<T>;
|
|
81
|
+
}[];
|
|
82
|
+
/**
|
|
83
|
+
* An optional cursor, when defined can be used to call find to get more entities.
|
|
84
|
+
*/
|
|
85
|
+
cursor?: string;
|
|
86
|
+
}>;
|
|
87
|
+
/**
|
|
88
|
+
* Get a list of identities including private profile data.
|
|
89
|
+
* @param publicFilters The filters to apply to the identities public profiles.
|
|
90
|
+
* @param privateFilters The filters to apply to the identities private profiles.
|
|
91
|
+
* @param publicPropertyNames The public properties to get for the profile, defaults to all.
|
|
92
|
+
* @param privatePropertyNames The private properties to get for the profile, defaults to none.
|
|
93
|
+
* @param cursor The cursor for paged requests.
|
|
94
|
+
* @param limit The maximum number of items in a page.
|
|
95
|
+
* @returns The list of items and cursor for paging.
|
|
96
|
+
*/
|
|
97
|
+
listAdmin(publicFilters?: {
|
|
98
|
+
propertyName: string;
|
|
99
|
+
propertyValue: unknown;
|
|
100
|
+
}[], privateFilters?: {
|
|
101
|
+
propertyName: string;
|
|
102
|
+
propertyValue: unknown;
|
|
103
|
+
}[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, limit?: number): Promise<{
|
|
75
104
|
/**
|
|
76
105
|
* The identities.
|
|
77
106
|
*/
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.2-next.7](https://github.com/iotaledger/twin-identity/compare/identity-service-v0.9.2-next.6...identity-service-v0.9.2-next.7) (2026-08-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* admin endpoints ([#199](https://github.com/iotaledger/twin-identity/issues/199)) ([da6c189](https://github.com/iotaledger/twin-identity/commit/da6c18963ed551451d919e36aedc1dd8b005a12f))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/identity-models bumped from 0.9.2-next.6 to 0.9.2-next.7
|
|
16
|
+
* devDependencies
|
|
17
|
+
* @twin.org/identity-connector-entity-storage bumped from 0.9.2-next.6 to 0.9.2-next.7
|
|
18
|
+
|
|
3
19
|
## [0.9.2-next.6](https://github.com/iotaledger/twin-identity/compare/identity-service-v0.9.2-next.5...identity-service-v0.9.2-next.6) (2026-08-11)
|
|
4
20
|
|
|
5
21
|
|