@twin.org/identity-rest-client 0.9.2-next.6 → 0.9.2-next.7

package/dist/es/identityProfileRestClient.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0.
 import { BaseRestClient } from "@twin.org/api-core";
 import { HttpParameterHelper } from "@twin.org/api-models";
-import { Coerce, Guards } from "@twin.org/core";
+import { Coerce, Guards, Is } from "@twin.org/core";
 import { HttpMethod } from "@twin.org/web";
 /**
  * Client for performing identity profile operations through REST endpoints.
@@ -44,9 +44,27 @@ export class IdentityProfileRestClient extends BaseRestClient {
      * Get the profile properties for an identity.
      * @param publicPropertyNames The public properties to get for the profile, defaults to all.
      * @param privatePropertyNames The private properties to get for the profile, defaults to all.
+     * @param identity The identity to perform the profile operation on, defaults to the current user.
      * @returns The identity and the items properties.
      */
-    async get(publicPropertyNames, privatePropertyNames) {
+    async get(publicPropertyNames, privatePropertyNames, identity) {
+        if (!Is.empty(identity)) {
+            Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
+            const response = await this.fetch("/:userIdentity", HttpMethod.GET, {
+                pathParams: {
+                    userIdentity: identity
+                },
+                query: {
+                    publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
+                    privatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)
+                }
+            });
+            return {
+                identity: response.body.identity,
+                publicProfile: response.body.publicProfile,
+                privateProfile: response.body.privateProfile
+            };
+        }
         const response = await this.fetch("/", HttpMethod.GET, {
             query: {
                 publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
@@ -81,9 +99,23 @@ export class IdentityProfileRestClient extends BaseRestClient {
      * Update the profile properties of an identity.
      * @param publicProfile The public profile data as JSON-LD.
      * @param privateProfile The private profile data as JSON-LD.
+     * @param identity The identity to perform the profile operation on, defaults to the current user.
      * @returns A promise that resolves when the profile has been updated.
      */
-    async update(publicProfile, privateProfile) {
+    async update(publicProfile, privateProfile, identity) {
+        if (!Is.empty(identity)) {
+            Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
+            await this.fetch("/:userIdentity", HttpMethod.PUT, {
+                pathParams: {
+                    userIdentity: identity
+                },
+                body: {
+                    publicProfile,
+                    privateProfile
+                }
+            });
+            return;
+        }
         await this.fetch("/", HttpMethod.PUT, {
             body: {
                 publicProfile,
@@ -93,9 +125,19 @@ export class IdentityProfileRestClient extends BaseRestClient {
     }
     /**
      * Delete the profile for an identity.
+     * @param identity The identity to perform the profile operation on, defaults to the current user.
      * @returns A promise that resolves when the profile has been removed.
      */
-    async remove() {
+    async remove(identity) {
+        if (!Is.empty(identity)) {
+            Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
+            await this.fetch("/:userIdentity", HttpMethod.DELETE, {
+                pathParams: {
+                    userIdentity: identity
+                }
+            });
+            return;
+        }
         await this.fetch("/", HttpMethod.DELETE);
     }
     /**
@@ -109,9 +151,7 @@ export class IdentityProfileRestClient extends BaseRestClient {
     async list(publicFilters, publicPropertyNames, cursor, limit) {
         const response = await this.fetch("/query", HttpMethod.GET, {
             query: {
-                publicFilters: HttpParameterHelper.arrayToString(
-                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                publicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)),
+                publicFilters: HttpParameterHelper.arrayToString(publicFilters?.map(f => `${f.propertyName}:${Coerce.string(f.propertyValue) ?? ""}`)),
                 publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
                 cursor,
                 limit: Coerce.string(limit)
@@ -122,5 +162,31 @@ export class IdentityProfileRestClient extends BaseRestClient {
             cursor: response.body.cursor
         };
     }
+    /**
+     * Get the list of identity profiles including private properties.
+     * @param publicFilters The filters to apply to the identities public profiles.
+     * @param privateFilters The filters to apply to the identities private profiles.
+     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
+     * @param privatePropertyNames The private properties to get for the profile, defaults to none.
+     * @param cursor The cursor for paged requests.
+     * @param limit The maximum number of items in a page.
+     * @returns The list of items and cursor for paging.
+     */
+    async listAdmin(publicFilters, privateFilters, publicPropertyNames, privatePropertyNames, cursor, limit) {
+        const response = await this.fetch("/admin/query", HttpMethod.GET, {
+            query: {
+                publicFilters: HttpParameterHelper.arrayToString(publicFilters?.map(f => `${f.propertyName}:${Coerce.string(f.propertyValue) ?? ""}`)),
+                privateFilters: HttpParameterHelper.arrayToString(privateFilters?.map(f => `${f.propertyName}:${Coerce.string(f.propertyValue) ?? ""}`)),
+                publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
+                privatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames),
+                cursor,
+                limit: Coerce.string(limit)
+            }
+        });
+        return {
+            items: response.body.items,
+            cursor: response.body.cursor
+        };
+    }
 }
 //# sourceMappingURL=identityProfileRestClient.js.map

package/dist/es/identityProfileRestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"identityProfileRestClient.js","sourceRoot":"","sources":["../../src/identityProfileRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAA8B,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAchD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,yBAIZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,+BAA+C;IAEhF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,8BAAsC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,yBAAyB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB;QACxD,MAAM,IAAI,CAAC,KAAK,CAAuC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE;YAC5E,IAAI,EAAE;gBACL,aAAa;gBACb,cAAc;aACd;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACf,mBAAiC,EACjC,oBAAkC;QAMlC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,UAAU,CAAC,GAAG,EACd;YACC,KAAK,EAAE;gBACN,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,oBAAoB,EAAE,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC;aAC7E;SACD,CACD,CAAC;QAEF,OAAO;YACN,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ;YAChC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAkB;YAC/C,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAmB;SACjD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,QAAgB,EAAE,aAA2B;QACnE,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEhF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,mBAAmB,EAAE,UAAU,CAAC,GAAG,EAAE;YACtC,UAAU,EAAE;gBACX,QAAQ;aACR;YACD,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC;aAC/D;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAkB,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB;QACxD,MAAM,IAAI,CAAC,KAAK,CAAuC,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE;YAC3E,IAAI,EAAE;gBACL,aAAa;gBACb,cAAc;aACd;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,KAAK,CAAe,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAChB,aAGG,EACH,mBAAiC,EACjC,MAAe,EACf,KAAc;QAcd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,QAAQ,EACR,UAAU,CAAC,GAAG,EACd;YACC,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa;gBAC/C,4EAA4E;gBAC5E,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC,CAC/D;gBACD,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CACD,CAAC;QACF,OAAO;YACN,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAGlB;YACH,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;SAC5B,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport { HttpParameterHelper, type IBaseRestClientConfig } from \"@twin.org/api-models\";\nimport { Coerce, Guards } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type {\n\tIIdentityProfileComponent,\n\tIIdentityProfileCreateRequest,\n\tIIdentityProfileGetPublicRequest,\n\tIIdentityProfileGetPublicResponse,\n\tIIdentityProfileGetRequest,\n\tIIdentityProfileGetResponse,\n\tIIdentityProfileListRequest,\n\tIIdentityProfileListResponse,\n\tIIdentityProfileUpdateRequest\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HttpMethod } from \"@twin.org/web\";\n\n/**\n * Client for performing identity profile operations through REST endpoints.\n */\nexport class IdentityProfileRestClient<\n\tT extends IJsonLdDocument = IJsonLdDocument,\n\tU extends IJsonLdDocument = IJsonLdDocument\n>\n\textends BaseRestClient\n\timplements IIdentityProfileComponent<T, U>\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityProfileRestClient>();\n\n\t/**\n\t * Create a new instance of IdentityProfileRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<IdentityProfileRestClient>(), config, \"identity/profile\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn IdentityProfileRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create the profile properties for an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @returns A promise that resolves when the profile has been created.\n\t */\n\tpublic async create(publicProfile?: T, privateProfile?: U): Promise<void> {\n\t\tawait this.fetch<IIdentityProfileCreateRequest, never>(\"/\", HttpMethod.POST, {\n\t\t\tbody: {\n\t\t\t\tpublicProfile,\n\t\t\t\tprivateProfile\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Get the profile properties for an identity.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param privatePropertyNames The private properties to get for the profile, defaults to all.\n\t * @returns The identity and the items properties.\n\t */\n\tpublic async get(\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tprivatePropertyNames?: (keyof U)[]\n\t): Promise<{\n\t\tidentity: string;\n\t\tpublicProfile?: Partial<T>;\n\t\tprivateProfile?: Partial<U>;\n\t}> {\n\t\tconst response = await this.fetch<IIdentityProfileGetRequest, IIdentityProfileGetResponse>(\n\t\t\t\"/\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tprivatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn {\n\t\t\tidentity: response.body.identity,\n\t\t\tpublicProfile: response.body.publicProfile as T,\n\t\t\tprivateProfile: response.body.privateProfile as U\n\t\t};\n\t}\n\n\t/**\n\t * Get the public profile properties for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @param propertyNames The public properties to get for the profile, defaults to all.\n\t * @returns The items properties.\n\t */\n\tpublic async getPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<T>> {\n\t\tGuards.string(IdentityProfileRestClient.CLASS_NAME, nameof(identity), identity);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityProfileGetPublicRequest,\n\t\t\tIIdentityProfileGetPublicResponse\n\t\t>(\"/:identity/public\", HttpMethod.GET, {\n\t\t\tpathParams: {\n\t\t\t\tidentity\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tpropertyNames: HttpParameterHelper.arrayToString(propertyNames)\n\t\t\t}\n\t\t});\n\n\t\treturn response.body as Partial<T>;\n\t}\n\n\t/**\n\t * Update the profile properties of an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @returns A promise that resolves when the profile has been updated.\n\t */\n\tpublic async update(publicProfile?: T, privateProfile?: U): Promise<void> {\n\t\tawait this.fetch<IIdentityProfileUpdateRequest, never>(\"/\", HttpMethod.PUT, {\n\t\t\tbody: {\n\t\t\t\tpublicProfile,\n\t\t\t\tprivateProfile\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Delete the profile for an identity.\n\t * @returns A promise that resolves when the profile has been removed.\n\t */\n\tpublic async remove(): Promise<void> {\n\t\tawait this.fetch<never, never>(\"/\", HttpMethod.DELETE);\n\t}\n\n\t/**\n\t * Get a list of the requested identities.\n\t * @param publicFilters The filters to apply to the identities public profiles.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param cursor The cursor for paged requests.\n\t * @param limit The maximum number of items in a page.\n\t * @returns The list of items and cursor for paging.\n\t */\n\tpublic async list(\n\t\tpublicFilters?: {\n\t\t\tpropertyName: string;\n\t\t\tpropertyValue: unknown;\n\t\t}[],\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The identities.\n\t\t */\n\t\titems: {\n\t\t\tidentity: string;\n\t\t\tpublicProfile?: Partial<T>;\n\t\t}[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<IIdentityProfileListRequest, IIdentityProfileListResponse>(\n\t\t\t\"/query\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\tpublicFilters: HttpParameterHelper.arrayToString(\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n\t\t\t\t\t\tpublicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)\n\t\t\t\t\t),\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tcursor,\n\t\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t\treturn {\n\t\t\titems: response.body.items as {\n\t\t\t\tidentity: string;\n\t\t\t\tpublicProfile?: Partial<T>;\n\t\t\t}[],\n\t\t\tcursor: response.body.cursor\n\t\t};\n\t}\n}\n"]}
+{"version":3,"file":"identityProfileRestClient.js","sourceRoot":"","sources":["../../src/identityProfileRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAA8B,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAmBpD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,yBAIZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,+BAA+C;IAEhF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,8BAAsC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,yBAAyB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB;QACxD,MAAM,IAAI,CAAC,KAAK,CAAuC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE;YAC5E,IAAI,EAAE;gBACL,aAAa;gBACb,cAAc;aACd;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,mBAAiC,EACjC,oBAAkC,EAClC,QAAiB;QAMjB,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;YAChF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,gBAAgB,EAAE,UAAU,CAAC,GAAG,EAAE;gBACnC,UAAU,EAAE;oBACX,YAAY,EAAE,QAAQ;iBACtB;gBACD,KAAK,EAAE;oBACN,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;oBAC3E,oBAAoB,EAAE,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC;iBAC7E;aACD,CAAC,CAAC;YACH,OAAO;gBACN,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ;gBAChC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAkB;gBAC/C,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAmB;aACjD,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,UAAU,CAAC,GAAG,EACd;YACC,KAAK,EAAE;gBACN,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,oBAAoB,EAAE,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC;aAC7E;SACD,CACD,CAAC;QAEF,OAAO;YACN,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ;YAChC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAkB;YAC/C,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAmB;SACjD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,QAAgB,EAAE,aAA2B;QACnE,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEhF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,mBAAmB,EAAE,UAAU,CAAC,GAAG,EAAE;YACtC,UAAU,EAAE;gBACX,QAAQ;aACR;YACD,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC;aAC/D;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAkB,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB,EAAE,QAAiB;QAC3E,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;YAChF,MAAM,IAAI,CAAC,KAAK,CACf,gBAAgB,EAChB,UAAU,CAAC,GAAG,EACd;gBACC,UAAU,EAAE;oBACX,YAAY,EAAE,QAAQ;iBACtB;gBACD,IAAI,EAAE;oBACL,aAAa;oBACb,cAAc;iBACd;aACD,CACD,CAAC;YACF,OAAO;QACR,CAAC;QACD,MAAM,IAAI,CAAC,KAAK,CAAuC,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE;YAC3E,IAAI,EAAE;gBACL,aAAa;gBACb,cAAc;aACd;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,QAAiB;QACpC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;YAChF,MAAM,IAAI,CAAC,KAAK,CACf,gBAAgB,EAChB,UAAU,CAAC,MAAM,EACjB;gBACC,UAAU,EAAE;oBACX,YAAY,EAAE,QAAQ;iBACtB;aACD,CACD,CAAC;YACF,OAAO;QACR,CAAC;QACD,MAAM,IAAI,CAAC,KAAK,CAAe,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAChB,aAGG,EACH,mBAAiC,EACjC,MAAe,EACf,KAAc;QAcd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,QAAQ,EACR,UAAU,CAAC,GAAG,EACd;YACC,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa,CAC/C,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CACpF;gBACD,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CACD,CAAC;QACF,OAAO;YACN,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAGlB;YACH,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;SAC5B,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,SAAS,CACrB,aAGG,EACH,cAGG,EACH,mBAAiC,EACjC,oBAAkC,EAClC,MAAe,EACf,KAAc;QASd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,cAAc,EAAE,UAAU,CAAC,GAAG,EAAE;YACjC,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa,CAC/C,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CACpF;gBACD,cAAc,EAAE,mBAAmB,CAAC,aAAa,CAChD,cAAc,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CACrF;gBACD,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,oBAAoB,EAAE,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC;gBAC7E,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QACH,OAAO;YACN,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAIlB;YACH,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;SAC5B,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport { HttpParameterHelper, type IBaseRestClientConfig } from \"@twin.org/api-models\";\nimport { Coerce, Guards, Is } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type {\n\tIIdentityProfileAdminGetRequest,\n\tIIdentityProfileAdminListRequest,\n\tIIdentityProfileAdminListResponse,\n\tIIdentityProfileAdminRemoveRequest,\n\tIIdentityProfileAdminUpdateRequest,\n\tIIdentityProfileComponent,\n\tIIdentityProfileCreateRequest,\n\tIIdentityProfileGetPublicRequest,\n\tIIdentityProfileGetPublicResponse,\n\tIIdentityProfileGetRequest,\n\tIIdentityProfileGetResponse,\n\tIIdentityProfileListRequest,\n\tIIdentityProfileListResponse,\n\tIIdentityProfileUpdateRequest\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HttpMethod } from \"@twin.org/web\";\n\n/**\n * Client for performing identity profile operations through REST endpoints.\n */\nexport class IdentityProfileRestClient<\n\tT extends IJsonLdDocument = IJsonLdDocument,\n\tU extends IJsonLdDocument = IJsonLdDocument\n>\n\textends BaseRestClient\n\timplements IIdentityProfileComponent<T, U>\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityProfileRestClient>();\n\n\t/**\n\t * Create a new instance of IdentityProfileRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<IdentityProfileRestClient>(), config, \"identity/profile\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn IdentityProfileRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create the profile properties for an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @returns A promise that resolves when the profile has been created.\n\t */\n\tpublic async create(publicProfile?: T, privateProfile?: U): Promise<void> {\n\t\tawait this.fetch<IIdentityProfileCreateRequest, never>(\"/\", HttpMethod.POST, {\n\t\t\tbody: {\n\t\t\t\tpublicProfile,\n\t\t\t\tprivateProfile\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Get the profile properties for an identity.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param privatePropertyNames The private properties to get for the profile, defaults to all.\n\t * @param identity The identity to perform the profile operation on, defaults to the current user.\n\t * @returns The identity and the items properties.\n\t */\n\tpublic async get(\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tprivatePropertyNames?: (keyof U)[],\n\t\tidentity?: string\n\t): Promise<{\n\t\tidentity: string;\n\t\tpublicProfile?: Partial<T>;\n\t\tprivateProfile?: Partial<U>;\n\t}> {\n\t\tif (!Is.empty(identity)) {\n\t\t\tGuards.string(IdentityProfileRestClient.CLASS_NAME, nameof(identity), identity);\n\t\t\tconst response = await this.fetch<\n\t\t\t\tIIdentityProfileAdminGetRequest,\n\t\t\t\tIIdentityProfileGetResponse\n\t\t\t>(\"/:userIdentity\", HttpMethod.GET, {\n\t\t\t\tpathParams: {\n\t\t\t\t\tuserIdentity: identity\n\t\t\t\t},\n\t\t\t\tquery: {\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tprivatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)\n\t\t\t\t}\n\t\t\t});\n\t\t\treturn {\n\t\t\t\tidentity: response.body.identity,\n\t\t\t\tpublicProfile: response.body.publicProfile as T,\n\t\t\t\tprivateProfile: response.body.privateProfile as U\n\t\t\t};\n\t\t}\n\t\tconst response = await this.fetch<IIdentityProfileGetRequest, IIdentityProfileGetResponse>(\n\t\t\t\"/\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tprivatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn {\n\t\t\tidentity: response.body.identity,\n\t\t\tpublicProfile: response.body.publicProfile as T,\n\t\t\tprivateProfile: response.body.privateProfile as U\n\t\t};\n\t}\n\n\t/**\n\t * Get the public profile properties for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @param propertyNames The public properties to get for the profile, defaults to all.\n\t * @returns The items properties.\n\t */\n\tpublic async getPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<T>> {\n\t\tGuards.string(IdentityProfileRestClient.CLASS_NAME, nameof(identity), identity);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityProfileGetPublicRequest,\n\t\t\tIIdentityProfileGetPublicResponse\n\t\t>(\"/:identity/public\", HttpMethod.GET, {\n\t\t\tpathParams: {\n\t\t\t\tidentity\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tpropertyNames: HttpParameterHelper.arrayToString(propertyNames)\n\t\t\t}\n\t\t});\n\n\t\treturn response.body as Partial<T>;\n\t}\n\n\t/**\n\t * Update the profile properties of an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @param identity The identity to perform the profile operation on, defaults to the current user.\n\t * @returns A promise that resolves when the profile has been updated.\n\t */\n\tpublic async update(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void> {\n\t\tif (!Is.empty(identity)) {\n\t\t\tGuards.string(IdentityProfileRestClient.CLASS_NAME, nameof(identity), identity);\n\t\t\tawait this.fetch<IIdentityProfileAdminUpdateRequest, never>(\n\t\t\t\t\"/:userIdentity\",\n\t\t\t\tHttpMethod.PUT,\n\t\t\t\t{\n\t\t\t\t\tpathParams: {\n\t\t\t\t\t\tuserIdentity: identity\n\t\t\t\t\t},\n\t\t\t\t\tbody: {\n\t\t\t\t\t\tpublicProfile,\n\t\t\t\t\t\tprivateProfile\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t);\n\t\t\treturn;\n\t\t}\n\t\tawait this.fetch<IIdentityProfileUpdateRequest, never>(\"/\", HttpMethod.PUT, {\n\t\t\tbody: {\n\t\t\t\tpublicProfile,\n\t\t\t\tprivateProfile\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Delete the profile for an identity.\n\t * @param identity The identity to perform the profile operation on, defaults to the current user.\n\t * @returns A promise that resolves when the profile has been removed.\n\t */\n\tpublic async remove(identity?: string): Promise<void> {\n\t\tif (!Is.empty(identity)) {\n\t\t\tGuards.string(IdentityProfileRestClient.CLASS_NAME, nameof(identity), identity);\n\t\t\tawait this.fetch<IIdentityProfileAdminRemoveRequest, never>(\n\t\t\t\t\"/:userIdentity\",\n\t\t\t\tHttpMethod.DELETE,\n\t\t\t\t{\n\t\t\t\t\tpathParams: {\n\t\t\t\t\t\tuserIdentity: identity\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t);\n\t\t\treturn;\n\t\t}\n\t\tawait this.fetch<never, never>(\"/\", HttpMethod.DELETE);\n\t}\n\n\t/**\n\t * Get a list of the requested identities.\n\t * @param publicFilters The filters to apply to the identities public profiles.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param cursor The cursor for paged requests.\n\t * @param limit The maximum number of items in a page.\n\t * @returns The list of items and cursor for paging.\n\t */\n\tpublic async list(\n\t\tpublicFilters?: {\n\t\t\tpropertyName: string;\n\t\t\tpropertyValue: unknown;\n\t\t}[],\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The identities.\n\t\t */\n\t\titems: {\n\t\t\tidentity: string;\n\t\t\tpublicProfile?: Partial<T>;\n\t\t}[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<IIdentityProfileListRequest, IIdentityProfileListResponse>(\n\t\t\t\"/query\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\tpublicFilters: HttpParameterHelper.arrayToString(\n\t\t\t\t\t\tpublicFilters?.map(f => `${f.propertyName}:${Coerce.string(f.propertyValue) ?? \"\"}`)\n\t\t\t\t\t),\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tcursor,\n\t\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t\treturn {\n\t\t\titems: response.body.items as {\n\t\t\t\tidentity: string;\n\t\t\t\tpublicProfile?: Partial<T>;\n\t\t\t}[],\n\t\t\tcursor: response.body.cursor\n\t\t};\n\t}\n\n\t/**\n\t * Get the list of identity profiles including private properties.\n\t * @param publicFilters The filters to apply to the identities public profiles.\n\t * @param privateFilters The filters to apply to the identities private profiles.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param privatePropertyNames The private properties to get for the profile, defaults to none.\n\t * @param cursor The cursor for paged requests.\n\t * @param limit The maximum number of items in a page.\n\t * @returns The list of items and cursor for paging.\n\t */\n\tpublic async listAdmin(\n\t\tpublicFilters?: {\n\t\t\tpropertyName: string;\n\t\t\tpropertyValue: unknown;\n\t\t}[],\n\t\tprivateFilters?: {\n\t\t\tpropertyName: string;\n\t\t\tpropertyValue: unknown;\n\t\t}[],\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tprivatePropertyNames?: (keyof U)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\titems: {\n\t\t\tidentity: string;\n\t\t\tpublicProfile?: Partial<T>;\n\t\t\tprivateProfile?: Partial<U>;\n\t\t}[];\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityProfileAdminListRequest,\n\t\t\tIIdentityProfileAdminListResponse\n\t\t>(\"/admin/query\", HttpMethod.GET, {\n\t\t\tquery: {\n\t\t\t\tpublicFilters: HttpParameterHelper.arrayToString(\n\t\t\t\t\tpublicFilters?.map(f => `${f.propertyName}:${Coerce.string(f.propertyValue) ?? \"\"}`)\n\t\t\t\t),\n\t\t\t\tprivateFilters: HttpParameterHelper.arrayToString(\n\t\t\t\t\tprivateFilters?.map(f => `${f.propertyName}:${Coerce.string(f.propertyValue) ?? \"\"}`)\n\t\t\t\t),\n\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\tprivatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames),\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\t\treturn {\n\t\t\titems: response.body.items as {\n\t\t\t\tidentity: string;\n\t\t\t\tpublicProfile?: Partial<T>;\n\t\t\t\tprivateProfile?: Partial<U>;\n\t\t\t}[],\n\t\t\tcursor: response.body.cursor\n\t\t};\n\t}\n}\n"]}

package/dist/types/identityProfileRestClient.d.ts

@@ -31,9 +31,10 @@ export declare class IdentityProfileRestClient<T extends IJsonLdDocument = IJson
      * Get the profile properties for an identity.
      * @param publicPropertyNames The public properties to get for the profile, defaults to all.
      * @param privatePropertyNames The private properties to get for the profile, defaults to all.
+     * @param identity The identity to perform the profile operation on, defaults to the current user.
      * @returns The identity and the items properties.
      */
-    get(publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[]): Promise<{
+    get(publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], identity?: string): Promise<{
         identity: string;
         publicProfile?: Partial<T>;
         privateProfile?: Partial<U>;
@@ -49,14 +50,16 @@ export declare class IdentityProfileRestClient<T extends IJsonLdDocument = IJson
      * Update the profile properties of an identity.
      * @param publicProfile The public profile data as JSON-LD.
      * @param privateProfile The private profile data as JSON-LD.
+     * @param identity The identity to perform the profile operation on, defaults to the current user.
      * @returns A promise that resolves when the profile has been updated.
      */
-    update(publicProfile?: T, privateProfile?: U): Promise<void>;
+    update(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;
     /**
      * Delete the profile for an identity.
+     * @param identity The identity to perform the profile operation on, defaults to the current user.
      * @returns A promise that resolves when the profile has been removed.
      */
-    remove(): Promise<void>;
+    remove(identity?: string): Promise<void>;
     /**
      * Get a list of the requested identities.
      * @param publicFilters The filters to apply to the identities public profiles.
@@ -81,4 +84,28 @@ export declare class IdentityProfileRestClient<T extends IJsonLdDocument = IJson
          */
         cursor?: string;
     }>;
+    /**
+     * Get the list of identity profiles including private properties.
+     * @param publicFilters The filters to apply to the identities public profiles.
+     * @param privateFilters The filters to apply to the identities private profiles.
+     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
+     * @param privatePropertyNames The private properties to get for the profile, defaults to none.
+     * @param cursor The cursor for paged requests.
+     * @param limit The maximum number of items in a page.
+     * @returns The list of items and cursor for paging.
+     */
+    listAdmin(publicFilters?: {
+        propertyName: string;
+        propertyValue: unknown;
+    }[], privateFilters?: {
+        propertyName: string;
+        propertyValue: unknown;
+    }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, limit?: number): Promise<{
+        items: {
+            identity: string;
+            publicProfile?: Partial<T>;
+            privateProfile?: Partial<U>;
+        }[];
+        cursor?: string;
+    }>;
 }

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.9.2-next.7](https://github.com/iotaledger/twin-identity/compare/identity-rest-client-v0.9.2-next.6...identity-rest-client-v0.9.2-next.7) (2026-08-14)
+
+
+### Features
+
+* admin endpoints ([#199](https://github.com/iotaledger/twin-identity/issues/199)) ([da6c189](https://github.com/iotaledger/twin-identity/commit/da6c18963ed551451d919e36aedc1dd8b005a12f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.9.2-next.6 to 0.9.2-next.7
+
 ## [0.9.2-next.6](https://github.com/iotaledger/twin-identity/compare/identity-rest-client-v0.9.2-next.5...identity-rest-client-v0.9.2-next.6) (2026-08-11)
 
 

package/docs/reference/classes/IdentityProfileRestClient.md

@@ -106,7 +106,7 @@ A promise that resolves when the profile has been created.
 
 ### get() {#get}
 
-> **get**(`publicPropertyNames?`, `privatePropertyNames?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
+> **get**(`publicPropertyNames?`, `privatePropertyNames?`, `identity?`): `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
@@ -124,6 +124,12 @@ keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
+##### identity?
+
+`string`
+
+The identity to perform the profile operation on, defaults to the current user.
+
 #### Returns
 
 `Promise`\<\{ `identity`: `string`; `publicProfile?`: `Partial`\<`T`\>; `privateProfile?`: `Partial`\<`U`\>; \}\>
@@ -170,7 +176,7 @@ The items properties.
 
 ### update() {#update}
 
-> **update**(`publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
+> **update**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
 Update the profile properties of an identity.
 
@@ -188,6 +194,12 @@ The public profile data as JSON-LD.
 
 The private profile data as JSON-LD.
 
+##### identity?
+
+`string`
+
+The identity to perform the profile operation on, defaults to the current user.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -202,10 +214,18 @@ A promise that resolves when the profile has been updated.
 
 ### remove() {#remove}
 
-> **remove**(): `Promise`\<`void`\>
+> **remove**(`identity?`): `Promise`\<`void`\>
 
 Delete the profile for an identity.
 
+#### Parameters
+
+##### identity?
+
+`string`
+
+The identity to perform the profile operation on, defaults to the current user.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -259,3 +279,59 @@ The list of items and cursor for paging.
 #### Implementation of
 
 `IIdentityProfileComponent.list`
+
+***
+
+### listAdmin() {#listadmin}
+
+> **listAdmin**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+Get the list of identity profiles including private properties.
+
+#### Parameters
+
+##### publicFilters?
+
+`object`[]
+
+The filters to apply to the identities public profiles.
+
+##### privateFilters?
+
+`object`[]
+
+The filters to apply to the identities private profiles.
+
+##### publicPropertyNames?
+
+keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+##### privatePropertyNames?
+
+keyof `U`[]
+
+The private properties to get for the profile, defaults to none.
+
+##### cursor?
+
+`string`
+
+The cursor for paged requests.
+
+##### limit?
+
+`number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+The list of items and cursor for paging.
+
+#### Implementation of
+
+`IIdentityProfileComponent.listAdmin`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-rest-client",
-	"version": "0.9.2-next.6",
+	"version": "0.9.2-next.7",
 	"description": "Client library for consuming identity REST endpoints through shared request and response contracts.",
 	"repository": {
 		"type": "git",
@@ -20,7 +20,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.9.2-next.6",
+		"@twin.org/identity-models": "0.9.2-next.7",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/web": "next"