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

package/docs/reference/classes/IdentityProfileService.md

@@ -277,3 +277,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 a list of identities including private profile data.
+
+#### 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/docs/reference/functions/identitiesAdminList.md

@@ -0,0 +1,31 @@
+# Function: identitiesAdminList()
+
+> **identitiesAdminList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileAdminListResponse`\>
+
+Get the list of identity profiles including private properties as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileAdminListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileAdminGet.md

@@ -0,0 +1,31 @@
+# Function: identityProfileAdminGet()
+
+> **identityProfileAdminGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileGetResponse`\>
+
+Get the identity profile of another user as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileAdminRemove.md

@@ -0,0 +1,31 @@
+# Function: identityProfileAdminRemove()
+
+> **identityProfileAdminRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the identity profile of another user as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileAdminUpdate.md

@@ -0,0 +1,31 @@
+# Function: identityProfileAdminUpdate()
+
+> **identityProfileAdminUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the identity profile of another user as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -26,10 +26,14 @@
 - [generateRestRoutesIdentityProfile](functions/generateRestRoutesIdentityProfile.md)
 - [identityProfileCreate](functions/identityProfileCreate.md)
 - [identityGet](functions/identityGet.md)
+- [identityProfileAdminGet](functions/identityProfileAdminGet.md)
 - [identityGetPublic](functions/identityGetPublic.md)
 - [identityProfileUpdate](functions/identityProfileUpdate.md)
+- [identityProfileAdminUpdate](functions/identityProfileAdminUpdate.md)
 - [identityProfileRemove](functions/identityProfileRemove.md)
+- [identityProfileAdminRemove](functions/identityProfileAdminRemove.md)
 - [identitiesList](functions/identitiesList.md)
+- [identitiesAdminList](functions/identitiesAdminList.md)
 - [generateRestRoutesIdentityResolver](functions/generateRestRoutesIdentityResolver.md)
 - [identityResolve](functions/identityResolve.md)
 - [generateRestRoutesIdentity](functions/generateRestRoutesIdentity.md)

package/locales/en.json

@@ -42,7 +42,8 @@
 			"updateFailed": "Updating the identity profile failed \"{identity}\"",
 			"notFound": "The identity profile could not be found \"{notFoundId}\"",
 			"removeFailed": "Removing the identity profile failed \"{identity}\"",
-			"listFailed": "Failed listing identities"
+			"listFailed": "Failed listing identities",
+			"listAdminFailed": "Failed listing identities with private data"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-service",
-	"version": "0.9.2-next.6",
+	"version": "0.9.2-next.7",
 	"description": "Service contracts and REST endpoint definitions for exposing identity workflows through stable interfaces.",
 	"repository": {
 		"type": "git",
@@ -21,7 +21,7 @@
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/dlt-account": "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/telemetry-models": "next",