@twin.org/identity-models 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/index.js +5 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IIdentityProfileComponent.js.map +1 -1
- package/dist/es/models/api/profile/IIdentityProfileAdminGetRequest.js +4 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminGetRequest.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListRequest.js +4 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListRequest.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListResponse.js +2 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminListResponse.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminRemoveRequest.js +4 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminRemoveRequest.js.map +1 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminUpdateRequest.js +2 -0
- package/dist/es/models/api/profile/IIdentityProfileAdminUpdateRequest.js.map +1 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/models/IIdentityProfileComponent.d.ts +30 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminGetRequest.d.ts +27 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminListRequest.d.ts +34 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminListResponse.d.ts +32 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminRemoveRequest.d.ts +14 -0
- package/dist/types/models/api/profile/IIdentityProfileAdminUpdateRequest.d.ts +28 -0
- package/docs/changelog.md +7 -0
- package/docs/reference/index.md +5 -0
- package/docs/reference/interfaces/IIdentityProfileAdminGetRequest.md +37 -0
- package/docs/reference/interfaces/IIdentityProfileAdminListRequest.md +47 -0
- package/docs/reference/interfaces/IIdentityProfileAdminListResponse.md +23 -0
- package/docs/reference/interfaces/IIdentityProfileAdminRemoveRequest.md +17 -0
- package/docs/reference/interfaces/IIdentityProfileAdminUpdateRequest.md +37 -0
- package/docs/reference/interfaces/IIdentityProfileComponent.md +52 -0
- package/package.json +1 -1
package/dist/es/index.js
CHANGED
|
@@ -31,6 +31,11 @@ export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyRespon
|
|
|
31
31
|
export * from "./models/api/identity/IIdentityVerificationMethodCreateRequest.js";
|
|
32
32
|
export * from "./models/api/identity/IIdentityVerificationMethodCreateResponse.js";
|
|
33
33
|
export * from "./models/api/identity/IIdentityVerificationMethodRemoveRequest.js";
|
|
34
|
+
export * from "./models/api/profile/IIdentityProfileAdminGetRequest.js";
|
|
35
|
+
export * from "./models/api/profile/IIdentityProfileAdminListRequest.js";
|
|
36
|
+
export * from "./models/api/profile/IIdentityProfileAdminListResponse.js";
|
|
37
|
+
export * from "./models/api/profile/IIdentityProfileAdminRemoveRequest.js";
|
|
38
|
+
export * from "./models/api/profile/IIdentityProfileAdminUpdateRequest.js";
|
|
34
39
|
export * from "./models/api/profile/IIdentityProfileCreateRequest.js";
|
|
35
40
|
export * from "./models/api/profile/IIdentityProfileGetPublicRequest.js";
|
|
36
41
|
export * from "./models/api/profile/IIdentityProfileGetPublicResponse.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,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,4DAA4D,CAAC;AAC3E,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,iDAAiD,CAAC;AAChE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,wDAAwD,CAAC;AACvE,cAAc,qEAAqE,CAAC;AACpF,cAAc,sEAAsE,CAAC;AACrF,cAAc,qEAAqE,CAAC;AACpF,cAAc,uEAAuE,CAAC;AACtF,cAAc,6EAA6E,CAAC;AAC5F,cAAc,qEAAqE,CAAC;AACpF,cAAc,sEAAsE,CAAC;AACrF,cAAc,uEAAuE,CAAC;AACtF,cAAc,wEAAwE,CAAC;AACvF,cAAc,+EAA+E,CAAC;AAC9F,cAAc,uEAAuE,CAAC;AACtF,cAAc,wEAAwE,CAAC;AACvF,cAAc,mEAAmE,CAAC;AAClF,cAAc,oEAAoE,CAAC;AACnF,cAAc,mEAAmE,CAAC;AAClF,cAAc,uDAAuD,CAAC;AACtE,cAAc,0DAA0D,CAAC;AACzE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,kDAAkD,CAAC;AACjE,cAAc,mDAAmD,CAAC;AAClE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./contextIdHandlers/didContextIdHandler.js\";\nexport * from \"./factories/identityConnectorFactory.js\";\nexport * from \"./factories/identityProfileConnectorFactory.js\";\nexport * from \"./factories/identityResolverConnectorFactory.js\";\nexport * from \"./models/api/identity/IIdentityAlsoKnownAsCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityAlsoKnownAsRemoveRequest.js\";\nexport * from \"./models/api/identity/IIdentityCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityProofCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityProofCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityProofVerifyRequest.js\";\nexport * from \"./models/api/identity/IIdentityProofVerifyResponse.js\";\nexport * from \"./models/api/identity/IIdentityRemoveRequest.js\";\nexport * from \"./models/api/identity/IIdentityServiceCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityServiceCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityServiceRemoveRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialRevokeRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialVerifyDocumentRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialVerifyRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialVerifyResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationVerifyDocumentRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationVerifyRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationVerifyResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerificationMethodCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerificationMethodCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerificationMethodRemoveRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileCreateRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetPublicRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetPublicResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileListRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileListResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileUpdateRequest.js\";\nexport * from \"./models/api/resolver/IIdentityResolveRequest.js\";\nexport * from \"./models/api/resolver/IIdentityResolveResponse.js\";\nexport * from \"./models/IIdentityComponent.js\";\nexport * from \"./models/IIdentityConnector.js\";\nexport * from \"./models/IIdentityProfileComponent.js\";\nexport * from \"./models/IIdentityProfileConnector.js\";\nexport * from \"./models/IIdentityResolverComponent.js\";\nexport * from \"./models/IIdentityResolverConnector.js\";\nexport * from \"./models/identityMetricIds.js\";\nexport * from \"./models/identityMetrics.js\";\nexport * from \"./types/did.js\";\nexport * from \"./utils/documentHelper.js\";\nexport * from \"./utils/verificationHelper.js\";\n"]}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,4DAA4D,CAAC;AAC3E,cAAc,4DAA4D,CAAC;AAC3E,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,iDAAiD,CAAC;AAChE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,wDAAwD,CAAC;AACvE,cAAc,qEAAqE,CAAC;AACpF,cAAc,sEAAsE,CAAC;AACrF,cAAc,qEAAqE,CAAC;AACpF,cAAc,uEAAuE,CAAC;AACtF,cAAc,6EAA6E,CAAC;AAC5F,cAAc,qEAAqE,CAAC;AACpF,cAAc,sEAAsE,CAAC;AACrF,cAAc,uEAAuE,CAAC;AACtF,cAAc,wEAAwE,CAAC;AACvF,cAAc,+EAA+E,CAAC;AAC9F,cAAc,uEAAuE,CAAC;AACtF,cAAc,wEAAwE,CAAC;AACvF,cAAc,mEAAmE,CAAC;AAClF,cAAc,oEAAoE,CAAC;AACnF,cAAc,mEAAmE,CAAC;AAClF,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,4DAA4D,CAAC;AAC3E,cAAc,4DAA4D,CAAC;AAC3E,cAAc,uDAAuD,CAAC;AACtE,cAAc,0DAA0D,CAAC;AACzE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,oDAAoD,CAAC;AACnE,cAAc,qDAAqD,CAAC;AACpE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,kDAAkD,CAAC;AACjE,cAAc,mDAAmD,CAAC;AAClE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./contextIdHandlers/didContextIdHandler.js\";\nexport * from \"./factories/identityConnectorFactory.js\";\nexport * from \"./factories/identityProfileConnectorFactory.js\";\nexport * from \"./factories/identityResolverConnectorFactory.js\";\nexport * from \"./models/api/identity/IIdentityAlsoKnownAsCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityAlsoKnownAsRemoveRequest.js\";\nexport * from \"./models/api/identity/IIdentityCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityProofCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityProofCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityProofVerifyRequest.js\";\nexport * from \"./models/api/identity/IIdentityProofVerifyResponse.js\";\nexport * from \"./models/api/identity/IIdentityRemoveRequest.js\";\nexport * from \"./models/api/identity/IIdentityServiceCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityServiceCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityServiceRemoveRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialRevokeRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialVerifyDocumentRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialVerifyRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiableCredentialVerifyResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationVerifyDocumentRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationVerifyRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerifiablePresentationVerifyResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerificationMethodCreateRequest.js\";\nexport * from \"./models/api/identity/IIdentityVerificationMethodCreateResponse.js\";\nexport * from \"./models/api/identity/IIdentityVerificationMethodRemoveRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileAdminGetRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileAdminListRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileAdminListResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileAdminRemoveRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileAdminUpdateRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileCreateRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetPublicRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetPublicResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileGetResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileListRequest.js\";\nexport * from \"./models/api/profile/IIdentityProfileListResponse.js\";\nexport * from \"./models/api/profile/IIdentityProfileUpdateRequest.js\";\nexport * from \"./models/api/resolver/IIdentityResolveRequest.js\";\nexport * from \"./models/api/resolver/IIdentityResolveResponse.js\";\nexport * from \"./models/IIdentityComponent.js\";\nexport * from \"./models/IIdentityConnector.js\";\nexport * from \"./models/IIdentityProfileComponent.js\";\nexport * from \"./models/IIdentityProfileConnector.js\";\nexport * from \"./models/IIdentityResolverComponent.js\";\nexport * from \"./models/IIdentityResolverConnector.js\";\nexport * from \"./models/identityMetricIds.js\";\nexport * from \"./models/identityMetrics.js\";\nexport * from \"./types/did.js\";\nexport * from \"./utils/documentHelper.js\";\nexport * from \"./utils/verificationHelper.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IIdentityProfileComponent.js","sourceRoot":"","sources":["../../../src/models/IIdentityProfileComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a contract which provides profile operations.\n */\nexport interface IIdentityProfileComponent<\n\tT extends IJsonLdDocument = IJsonLdDocument,\n\tU extends IJsonLdDocument = IJsonLdDocument\n> extends IComponent {\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 * @param identity The identity to perform the profile operation on.\n\t * @returns A promise that resolves when the profile has been created.\n\t */\n\tcreate(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;\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.\n\t * @returns The items identity and the properties.\n\t */\n\tget(\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\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\tgetPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<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.\n\t * @returns A promise that resolves when the profile has been updated.\n\t */\n\tupdate(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;\n\n\t/**\n\t * Delete the profile for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @returns A promise that resolves when the profile has been removed.\n\t */\n\tremove(identity?: string): Promise<void>;\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\tlist(\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}\n"]}
|
|
1
|
+
{"version":3,"file":"IIdentityProfileComponent.js","sourceRoot":"","sources":["../../../src/models/IIdentityProfileComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a contract which provides profile operations.\n */\nexport interface IIdentityProfileComponent<\n\tT extends IJsonLdDocument = IJsonLdDocument,\n\tU extends IJsonLdDocument = IJsonLdDocument\n> extends IComponent {\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 * @param identity The identity to perform the profile operation on.\n\t * @returns A promise that resolves when the profile has been created.\n\t */\n\tcreate(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;\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.\n\t * @returns The items identity and the properties.\n\t */\n\tget(\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\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\tgetPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<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.\n\t * @returns A promise that resolves when the profile has been updated.\n\t */\n\tupdate(publicProfile?: T, privateProfile?: U, identity?: string): Promise<void>;\n\n\t/**\n\t * Delete the profile for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @returns A promise that resolves when the profile has been removed.\n\t */\n\tremove(identity?: string): Promise<void>;\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\tlist(\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\n\t/**\n\t * Get a list of identities including private profile data.\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\tlistAdmin(\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\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\tprivateProfile?: Partial<U>;\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}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IIdentityProfileAdminGetRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/profile/IIdentityProfileAdminGetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to get the profile of another user as an admin.\n */\nexport interface IIdentityProfileAdminGetRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identity of the user whose profile is to be retrieved.\n\t\t */\n\t\tuserIdentity: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The public properties to get for the profile, defaults to all, should be a comma separated list.\n\t\t */\n\t\tpublicPropertyNames?: string;\n\n\t\t/**\n\t\t * The private properties to get for the profile, defaults to all, should be a comma separated list.\n\t\t */\n\t\tprivatePropertyNames?: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IIdentityProfileAdminListRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/profile/IIdentityProfileAdminListRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to get a list of identities with public and private profile data as an admin.\n */\nexport interface IIdentityProfileAdminListRequest {\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The public filters to apply to the list, comma separated list with colon between key and value for each pair e.g. prop1:value1,prop2:value2.\n\t\t */\n\t\tpublicFilters?: string;\n\n\t\t/**\n\t\t * The private filters to apply to the list, comma separated list with colon between key and value for each pair e.g. prop1:value1,prop2:value2.\n\t\t */\n\t\tprivateFilters?: string;\n\n\t\t/**\n\t\t * The public properties to get for the profile, defaults to all, should be a comma separated list.\n\t\t */\n\t\tpublicPropertyNames?: string;\n\n\t\t/**\n\t\t * The private properties to get for the profile, defaults to none, should be a comma separated list.\n\t\t */\n\t\tprivatePropertyNames?: string;\n\n\t\t/**\n\t\t * The cursor for paged requests.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Number of items to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IIdentityProfileAdminListResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/profile/IIdentityProfileAdminListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to get an admin list of identities including private profile data.\n */\nexport interface IIdentityProfileAdminListResponse {\n\t/**\n\t * The response payload.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The identities.\n\t\t */\n\t\titems: {\n\t\t\t/**\n\t\t\t * The identity.\n\t\t\t */\n\t\t\tidentity: string;\n\n\t\t\t/**\n\t\t\t * The public profile data.\n\t\t\t */\n\t\t\tpublicProfile?: Partial<IJsonLdDocument>;\n\n\t\t\t/**\n\t\t\t * The private profile data.\n\t\t\t */\n\t\t\tprivateProfile?: Partial<IJsonLdDocument>;\n\t\t}[];\n\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}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IIdentityProfileAdminRemoveRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/profile/IIdentityProfileAdminRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to remove the profile of another user as an admin.\n */\nexport interface IIdentityProfileAdminRemoveRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identity of the user whose profile is to be removed.\n\t\t */\n\t\tuserIdentity: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IIdentityProfileAdminUpdateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/profile/IIdentityProfileAdminUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\n\n/**\n * Request to update the profile of another user as an admin.\n */\nexport interface IIdentityProfileAdminUpdateRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identity of the user whose profile is to be updated.\n\t\t */\n\t\tuserIdentity: string;\n\t};\n\n\t/**\n\t * The data for the request.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The public profile data.\n\t\t */\n\t\tpublicProfile?: IJsonLdDocument;\n\n\t\t/**\n\t\t * The private profile data.\n\t\t */\n\t\tprivateProfile?: IJsonLdDocument;\n\t};\n}\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -29,6 +29,11 @@ export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyRespon
|
|
|
29
29
|
export * from "./models/api/identity/IIdentityVerificationMethodCreateRequest.js";
|
|
30
30
|
export * from "./models/api/identity/IIdentityVerificationMethodCreateResponse.js";
|
|
31
31
|
export * from "./models/api/identity/IIdentityVerificationMethodRemoveRequest.js";
|
|
32
|
+
export * from "./models/api/profile/IIdentityProfileAdminGetRequest.js";
|
|
33
|
+
export * from "./models/api/profile/IIdentityProfileAdminListRequest.js";
|
|
34
|
+
export * from "./models/api/profile/IIdentityProfileAdminListResponse.js";
|
|
35
|
+
export * from "./models/api/profile/IIdentityProfileAdminRemoveRequest.js";
|
|
36
|
+
export * from "./models/api/profile/IIdentityProfileAdminUpdateRequest.js";
|
|
32
37
|
export * from "./models/api/profile/IIdentityProfileCreateRequest.js";
|
|
33
38
|
export * from "./models/api/profile/IIdentityProfileGetPublicRequest.js";
|
|
34
39
|
export * from "./models/api/profile/IIdentityProfileGetPublicResponse.js";
|
|
@@ -69,4 +69,34 @@ export interface IIdentityProfileComponent<T extends IJsonLdDocument = IJsonLdDo
|
|
|
69
69
|
*/
|
|
70
70
|
cursor?: string;
|
|
71
71
|
}>;
|
|
72
|
+
/**
|
|
73
|
+
* Get a list of identities including private profile data.
|
|
74
|
+
* @param publicFilters The filters to apply to the identities public profiles.
|
|
75
|
+
* @param privateFilters The filters to apply to the identities private profiles.
|
|
76
|
+
* @param publicPropertyNames The public properties to get for the profile, defaults to all.
|
|
77
|
+
* @param privatePropertyNames The private properties to get for the profile, defaults to none.
|
|
78
|
+
* @param cursor The cursor for paged requests.
|
|
79
|
+
* @param limit The maximum number of items in a page.
|
|
80
|
+
* @returns The list of items and cursor for paging.
|
|
81
|
+
*/
|
|
82
|
+
listAdmin(publicFilters?: {
|
|
83
|
+
propertyName: string;
|
|
84
|
+
propertyValue: unknown;
|
|
85
|
+
}[], privateFilters?: {
|
|
86
|
+
propertyName: string;
|
|
87
|
+
propertyValue: unknown;
|
|
88
|
+
}[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, limit?: number): Promise<{
|
|
89
|
+
/**
|
|
90
|
+
* The identities.
|
|
91
|
+
*/
|
|
92
|
+
items: {
|
|
93
|
+
identity: string;
|
|
94
|
+
publicProfile?: Partial<T>;
|
|
95
|
+
privateProfile?: Partial<U>;
|
|
96
|
+
}[];
|
|
97
|
+
/**
|
|
98
|
+
* An optional cursor, when defined can be used to call find to get more entities.
|
|
99
|
+
*/
|
|
100
|
+
cursor?: string;
|
|
101
|
+
}>;
|
|
72
102
|
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Request to get the profile of another user as an admin.
|
|
3
|
+
*/
|
|
4
|
+
export interface IIdentityProfileAdminGetRequest {
|
|
5
|
+
/**
|
|
6
|
+
* The path parameters.
|
|
7
|
+
*/
|
|
8
|
+
pathParams: {
|
|
9
|
+
/**
|
|
10
|
+
* The identity of the user whose profile is to be retrieved.
|
|
11
|
+
*/
|
|
12
|
+
userIdentity: string;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* The query parameters.
|
|
16
|
+
*/
|
|
17
|
+
query?: {
|
|
18
|
+
/**
|
|
19
|
+
* The public properties to get for the profile, defaults to all, should be a comma separated list.
|
|
20
|
+
*/
|
|
21
|
+
publicPropertyNames?: string;
|
|
22
|
+
/**
|
|
23
|
+
* The private properties to get for the profile, defaults to all, should be a comma separated list.
|
|
24
|
+
*/
|
|
25
|
+
privatePropertyNames?: string;
|
|
26
|
+
};
|
|
27
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Request to get a list of identities with public and private profile data as an admin.
|
|
3
|
+
*/
|
|
4
|
+
export interface IIdentityProfileAdminListRequest {
|
|
5
|
+
/**
|
|
6
|
+
* The query parameters.
|
|
7
|
+
*/
|
|
8
|
+
query?: {
|
|
9
|
+
/**
|
|
10
|
+
* The public filters to apply to the list, comma separated list with colon between key and value for each pair e.g. prop1:value1,prop2:value2.
|
|
11
|
+
*/
|
|
12
|
+
publicFilters?: string;
|
|
13
|
+
/**
|
|
14
|
+
* The private filters to apply to the list, comma separated list with colon between key and value for each pair e.g. prop1:value1,prop2:value2.
|
|
15
|
+
*/
|
|
16
|
+
privateFilters?: string;
|
|
17
|
+
/**
|
|
18
|
+
* The public properties to get for the profile, defaults to all, should be a comma separated list.
|
|
19
|
+
*/
|
|
20
|
+
publicPropertyNames?: string;
|
|
21
|
+
/**
|
|
22
|
+
* The private properties to get for the profile, defaults to none, should be a comma separated list.
|
|
23
|
+
*/
|
|
24
|
+
privatePropertyNames?: string;
|
|
25
|
+
/**
|
|
26
|
+
* The cursor for paged requests.
|
|
27
|
+
*/
|
|
28
|
+
cursor?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Number of items to return.
|
|
31
|
+
*/
|
|
32
|
+
limit?: string;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { IJsonLdDocument } from "@twin.org/data-json-ld";
|
|
2
|
+
/**
|
|
3
|
+
* Response to get an admin list of identities including private profile data.
|
|
4
|
+
*/
|
|
5
|
+
export interface IIdentityProfileAdminListResponse {
|
|
6
|
+
/**
|
|
7
|
+
* The response payload.
|
|
8
|
+
*/
|
|
9
|
+
body: {
|
|
10
|
+
/**
|
|
11
|
+
* The identities.
|
|
12
|
+
*/
|
|
13
|
+
items: {
|
|
14
|
+
/**
|
|
15
|
+
* The identity.
|
|
16
|
+
*/
|
|
17
|
+
identity: string;
|
|
18
|
+
/**
|
|
19
|
+
* The public profile data.
|
|
20
|
+
*/
|
|
21
|
+
publicProfile?: Partial<IJsonLdDocument>;
|
|
22
|
+
/**
|
|
23
|
+
* The private profile data.
|
|
24
|
+
*/
|
|
25
|
+
privateProfile?: Partial<IJsonLdDocument>;
|
|
26
|
+
}[];
|
|
27
|
+
/**
|
|
28
|
+
* An optional cursor, when defined can be used to call find to get more entities.
|
|
29
|
+
*/
|
|
30
|
+
cursor?: string;
|
|
31
|
+
};
|
|
32
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Request to remove the profile of another user as an admin.
|
|
3
|
+
*/
|
|
4
|
+
export interface IIdentityProfileAdminRemoveRequest {
|
|
5
|
+
/**
|
|
6
|
+
* The path parameters.
|
|
7
|
+
*/
|
|
8
|
+
pathParams: {
|
|
9
|
+
/**
|
|
10
|
+
* The identity of the user whose profile is to be removed.
|
|
11
|
+
*/
|
|
12
|
+
userIdentity: string;
|
|
13
|
+
};
|
|
14
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { IJsonLdDocument } from "@twin.org/data-json-ld";
|
|
2
|
+
/**
|
|
3
|
+
* Request to update the profile of another user as an admin.
|
|
4
|
+
*/
|
|
5
|
+
export interface IIdentityProfileAdminUpdateRequest {
|
|
6
|
+
/**
|
|
7
|
+
* The path parameters.
|
|
8
|
+
*/
|
|
9
|
+
pathParams: {
|
|
10
|
+
/**
|
|
11
|
+
* The identity of the user whose profile is to be updated.
|
|
12
|
+
*/
|
|
13
|
+
userIdentity: string;
|
|
14
|
+
};
|
|
15
|
+
/**
|
|
16
|
+
* The data for the request.
|
|
17
|
+
*/
|
|
18
|
+
body: {
|
|
19
|
+
/**
|
|
20
|
+
* The public profile data.
|
|
21
|
+
*/
|
|
22
|
+
publicProfile?: IJsonLdDocument;
|
|
23
|
+
/**
|
|
24
|
+
* The private profile data.
|
|
25
|
+
*/
|
|
26
|
+
privateProfile?: IJsonLdDocument;
|
|
27
|
+
};
|
|
28
|
+
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.2-next.7](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.6...identity-models-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
|
+
|
|
3
10
|
## [0.9.2-next.6](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.5...identity-models-v0.9.2-next.6) (2026-08-11)
|
|
4
11
|
|
|
5
12
|
|
package/docs/reference/index.md
CHANGED
|
@@ -42,6 +42,11 @@
|
|
|
42
42
|
- [IIdentityVerificationMethodCreateRequest](interfaces/IIdentityVerificationMethodCreateRequest.md)
|
|
43
43
|
- [IIdentityVerificationMethodCreateResponse](interfaces/IIdentityVerificationMethodCreateResponse.md)
|
|
44
44
|
- [IIdentityVerificationMethodRemoveRequest](interfaces/IIdentityVerificationMethodRemoveRequest.md)
|
|
45
|
+
- [IIdentityProfileAdminGetRequest](interfaces/IIdentityProfileAdminGetRequest.md)
|
|
46
|
+
- [IIdentityProfileAdminListRequest](interfaces/IIdentityProfileAdminListRequest.md)
|
|
47
|
+
- [IIdentityProfileAdminListResponse](interfaces/IIdentityProfileAdminListResponse.md)
|
|
48
|
+
- [IIdentityProfileAdminRemoveRequest](interfaces/IIdentityProfileAdminRemoveRequest.md)
|
|
49
|
+
- [IIdentityProfileAdminUpdateRequest](interfaces/IIdentityProfileAdminUpdateRequest.md)
|
|
45
50
|
- [IIdentityProfileCreateRequest](interfaces/IIdentityProfileCreateRequest.md)
|
|
46
51
|
- [IIdentityProfileGetPublicRequest](interfaces/IIdentityProfileGetPublicRequest.md)
|
|
47
52
|
- [IIdentityProfileGetPublicResponse](interfaces/IIdentityProfileGetPublicResponse.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Interface: IIdentityProfileAdminGetRequest
|
|
2
|
+
|
|
3
|
+
Request to get the profile of another user as an admin.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### pathParams {#pathparams}
|
|
8
|
+
|
|
9
|
+
> **pathParams**: `object`
|
|
10
|
+
|
|
11
|
+
The path parameters.
|
|
12
|
+
|
|
13
|
+
#### userIdentity
|
|
14
|
+
|
|
15
|
+
> **userIdentity**: `string`
|
|
16
|
+
|
|
17
|
+
The identity of the user whose profile is to be retrieved.
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### query? {#query}
|
|
22
|
+
|
|
23
|
+
> `optional` **query?**: `object`
|
|
24
|
+
|
|
25
|
+
The query parameters.
|
|
26
|
+
|
|
27
|
+
#### publicPropertyNames?
|
|
28
|
+
|
|
29
|
+
> `optional` **publicPropertyNames?**: `string`
|
|
30
|
+
|
|
31
|
+
The public properties to get for the profile, defaults to all, should be a comma separated list.
|
|
32
|
+
|
|
33
|
+
#### privatePropertyNames?
|
|
34
|
+
|
|
35
|
+
> `optional` **privatePropertyNames?**: `string`
|
|
36
|
+
|
|
37
|
+
The private properties to get for the profile, defaults to all, should be a comma separated list.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Interface: IIdentityProfileAdminListRequest
|
|
2
|
+
|
|
3
|
+
Request to get a list of identities with public and private profile data as an admin.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### query? {#query}
|
|
8
|
+
|
|
9
|
+
> `optional` **query?**: `object`
|
|
10
|
+
|
|
11
|
+
The query parameters.
|
|
12
|
+
|
|
13
|
+
#### publicFilters?
|
|
14
|
+
|
|
15
|
+
> `optional` **publicFilters?**: `string`
|
|
16
|
+
|
|
17
|
+
The public filters to apply to the list, comma separated list with colon between key and value for each pair e.g. prop1:value1,prop2:value2.
|
|
18
|
+
|
|
19
|
+
#### privateFilters?
|
|
20
|
+
|
|
21
|
+
> `optional` **privateFilters?**: `string`
|
|
22
|
+
|
|
23
|
+
The private filters to apply to the list, comma separated list with colon between key and value for each pair e.g. prop1:value1,prop2:value2.
|
|
24
|
+
|
|
25
|
+
#### publicPropertyNames?
|
|
26
|
+
|
|
27
|
+
> `optional` **publicPropertyNames?**: `string`
|
|
28
|
+
|
|
29
|
+
The public properties to get for the profile, defaults to all, should be a comma separated list.
|
|
30
|
+
|
|
31
|
+
#### privatePropertyNames?
|
|
32
|
+
|
|
33
|
+
> `optional` **privatePropertyNames?**: `string`
|
|
34
|
+
|
|
35
|
+
The private properties to get for the profile, defaults to none, should be a comma separated list.
|
|
36
|
+
|
|
37
|
+
#### cursor?
|
|
38
|
+
|
|
39
|
+
> `optional` **cursor?**: `string`
|
|
40
|
+
|
|
41
|
+
The cursor for paged requests.
|
|
42
|
+
|
|
43
|
+
#### limit?
|
|
44
|
+
|
|
45
|
+
> `optional` **limit?**: `string`
|
|
46
|
+
|
|
47
|
+
Number of items to return.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Interface: IIdentityProfileAdminListResponse
|
|
2
|
+
|
|
3
|
+
Response to get an admin list of identities including private profile data.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### body {#body}
|
|
8
|
+
|
|
9
|
+
> **body**: `object`
|
|
10
|
+
|
|
11
|
+
The response payload.
|
|
12
|
+
|
|
13
|
+
#### items
|
|
14
|
+
|
|
15
|
+
> **items**: `object`[]
|
|
16
|
+
|
|
17
|
+
The identities.
|
|
18
|
+
|
|
19
|
+
#### cursor?
|
|
20
|
+
|
|
21
|
+
> `optional` **cursor?**: `string`
|
|
22
|
+
|
|
23
|
+
An optional cursor, when defined can be used to call find to get more entities.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Interface: IIdentityProfileAdminRemoveRequest
|
|
2
|
+
|
|
3
|
+
Request to remove the profile of another user as an admin.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### pathParams {#pathparams}
|
|
8
|
+
|
|
9
|
+
> **pathParams**: `object`
|
|
10
|
+
|
|
11
|
+
The path parameters.
|
|
12
|
+
|
|
13
|
+
#### userIdentity
|
|
14
|
+
|
|
15
|
+
> **userIdentity**: `string`
|
|
16
|
+
|
|
17
|
+
The identity of the user whose profile is to be removed.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Interface: IIdentityProfileAdminUpdateRequest
|
|
2
|
+
|
|
3
|
+
Request to update the profile of another user as an admin.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### pathParams {#pathparams}
|
|
8
|
+
|
|
9
|
+
> **pathParams**: `object`
|
|
10
|
+
|
|
11
|
+
The path parameters.
|
|
12
|
+
|
|
13
|
+
#### userIdentity
|
|
14
|
+
|
|
15
|
+
> **userIdentity**: `string`
|
|
16
|
+
|
|
17
|
+
The identity of the user whose profile is to be updated.
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### body {#body}
|
|
22
|
+
|
|
23
|
+
> **body**: `object`
|
|
24
|
+
|
|
25
|
+
The data for the request.
|
|
26
|
+
|
|
27
|
+
#### publicProfile?
|
|
28
|
+
|
|
29
|
+
> `optional` **publicProfile?**: `IJsonLdDocument`
|
|
30
|
+
|
|
31
|
+
The public profile data.
|
|
32
|
+
|
|
33
|
+
#### privateProfile?
|
|
34
|
+
|
|
35
|
+
> `optional` **privateProfile?**: `IJsonLdDocument`
|
|
36
|
+
|
|
37
|
+
The private profile data.
|
|
@@ -207,3 +207,55 @@ The maximum number of items in a page.
|
|
|
207
207
|
`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
|
|
208
208
|
|
|
209
209
|
The list of items and cursor for paging.
|
|
210
|
+
|
|
211
|
+
***
|
|
212
|
+
|
|
213
|
+
### listAdmin() {#listadmin}
|
|
214
|
+
|
|
215
|
+
> **listAdmin**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
|
|
216
|
+
|
|
217
|
+
Get a list of identities including private profile data.
|
|
218
|
+
|
|
219
|
+
#### Parameters
|
|
220
|
+
|
|
221
|
+
##### publicFilters?
|
|
222
|
+
|
|
223
|
+
`object`[]
|
|
224
|
+
|
|
225
|
+
The filters to apply to the identities public profiles.
|
|
226
|
+
|
|
227
|
+
##### privateFilters?
|
|
228
|
+
|
|
229
|
+
`object`[]
|
|
230
|
+
|
|
231
|
+
The filters to apply to the identities private profiles.
|
|
232
|
+
|
|
233
|
+
##### publicPropertyNames?
|
|
234
|
+
|
|
235
|
+
keyof `T`[]
|
|
236
|
+
|
|
237
|
+
The public properties to get for the profile, defaults to all.
|
|
238
|
+
|
|
239
|
+
##### privatePropertyNames?
|
|
240
|
+
|
|
241
|
+
keyof `U`[]
|
|
242
|
+
|
|
243
|
+
The private properties to get for the profile, defaults to none.
|
|
244
|
+
|
|
245
|
+
##### cursor?
|
|
246
|
+
|
|
247
|
+
`string`
|
|
248
|
+
|
|
249
|
+
The cursor for paged requests.
|
|
250
|
+
|
|
251
|
+
##### limit?
|
|
252
|
+
|
|
253
|
+
`number`
|
|
254
|
+
|
|
255
|
+
The maximum number of items in a page.
|
|
256
|
+
|
|
257
|
+
#### Returns
|
|
258
|
+
|
|
259
|
+
`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
|
|
260
|
+
|
|
261
|
+
The list of items and cursor for paging.
|
package/package.json
CHANGED