@twin.org/identity-models 0.9.1 → 0.9.2-next.10
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/contextIdHandlers/didContextIdHandler.js +14 -1
- package/dist/es/contextIdHandlers/didContextIdHandler.js.map +1 -1
- package/dist/es/index.js +7 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IIdentityComponent.js.map +1 -1
- package/dist/es/models/IIdentityConnector.js.map +1 -1
- package/dist/es/models/IIdentityProfileComponent.js.map +1 -1
- package/dist/es/models/api/identity/IIdentityRemoveRequest.js.map +1 -1
- package/dist/es/models/api/identity/IIdentityVerificationMethodRemoveRequest.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/es/models/identitySpanAttributes.js +21 -0
- package/dist/es/models/identitySpanAttributes.js.map +1 -0
- package/dist/es/models/identitySpanNames.js +73 -0
- package/dist/es/models/identitySpanNames.js.map +1 -0
- package/dist/types/contextIdHandlers/didContextIdHandler.d.ts +6 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/models/IIdentityComponent.d.ts +10 -2
- package/dist/types/models/IIdentityConnector.d.ts +10 -2
- package/dist/types/models/IIdentityProfileComponent.d.ts +30 -0
- package/dist/types/models/api/identity/IIdentityRemoveRequest.d.ts +9 -0
- package/dist/types/models/api/identity/IIdentityVerificationMethodRemoveRequest.d.ts +9 -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/dist/types/models/identitySpanAttributes.d.ts +21 -0
- package/dist/types/models/identitySpanNames.d.ts +73 -0
- package/docs/changelog.md +167 -0
- package/docs/reference/classes/DidContextIdHandler.md +26 -0
- package/docs/reference/index.md +9 -0
- package/docs/reference/interfaces/IIdentityComponent.md +22 -2
- package/docs/reference/interfaces/IIdentityConnector.md +22 -2
- 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/docs/reference/interfaces/IIdentityRemoveRequest.md +14 -0
- package/docs/reference/interfaces/IIdentityVerificationMethodRemoveRequest.md +14 -0
- package/docs/reference/type-aliases/IdentitySpanAttributes.md +5 -0
- package/docs/reference/type-aliases/IdentitySpanNames.md +5 -0
- package/docs/reference/variables/IdentitySpanAttributes.md +25 -0
- package/docs/reference/variables/IdentitySpanNames.md +103 -0
- package/package.json +10 -9
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The span attribute keys for the identity domain.
|
|
3
|
+
*/
|
|
4
|
+
export declare const IdentitySpanAttributes: {
|
|
5
|
+
/**
|
|
6
|
+
* The id of the identity document the operation is for.
|
|
7
|
+
*/
|
|
8
|
+
readonly Id: "identity.id";
|
|
9
|
+
/**
|
|
10
|
+
* The id of the verification method the operation is for.
|
|
11
|
+
*/
|
|
12
|
+
readonly VerificationMethodId: "identity.verification-method-id";
|
|
13
|
+
/**
|
|
14
|
+
* The id of the service the operation is for.
|
|
15
|
+
*/
|
|
16
|
+
readonly ServiceId: "identity.service-id";
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Union type of all identity span attribute key string values.
|
|
20
|
+
*/
|
|
21
|
+
export type IdentitySpanAttributes = (typeof IdentitySpanAttributes)[keyof typeof IdentitySpanAttributes];
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The span names for the identity domain.
|
|
3
|
+
*/
|
|
4
|
+
export declare const IdentitySpanNames: {
|
|
5
|
+
/**
|
|
6
|
+
* Create an identity.
|
|
7
|
+
*/
|
|
8
|
+
readonly Create: "identity/create";
|
|
9
|
+
/**
|
|
10
|
+
* Remove an identity.
|
|
11
|
+
*/
|
|
12
|
+
readonly Remove: "identity/remove";
|
|
13
|
+
/**
|
|
14
|
+
* Create a verification method.
|
|
15
|
+
*/
|
|
16
|
+
readonly VerificationMethodCreate: "identity/verification-method-create";
|
|
17
|
+
/**
|
|
18
|
+
* Remove a verification method.
|
|
19
|
+
*/
|
|
20
|
+
readonly VerificationMethodRemove: "identity/verification-method-remove";
|
|
21
|
+
/**
|
|
22
|
+
* Create a service.
|
|
23
|
+
*/
|
|
24
|
+
readonly ServiceCreate: "identity/service-create";
|
|
25
|
+
/**
|
|
26
|
+
* Remove a service.
|
|
27
|
+
*/
|
|
28
|
+
readonly ServiceRemove: "identity/service-remove";
|
|
29
|
+
/**
|
|
30
|
+
* Add an also known as alias.
|
|
31
|
+
*/
|
|
32
|
+
readonly AlsoKnownAsAdd: "identity/also-known-as-add";
|
|
33
|
+
/**
|
|
34
|
+
* Remove an also known as alias.
|
|
35
|
+
*/
|
|
36
|
+
readonly AlsoKnownAsRemove: "identity/also-known-as-remove";
|
|
37
|
+
/**
|
|
38
|
+
* Create a verifiable credential.
|
|
39
|
+
*/
|
|
40
|
+
readonly VerifiableCredentialCreate: "identity/verifiable-credential-create";
|
|
41
|
+
/**
|
|
42
|
+
* Verify a verifiable credential.
|
|
43
|
+
*/
|
|
44
|
+
readonly VerifiableCredentialVerify: "identity/verifiable-credential-verify";
|
|
45
|
+
/**
|
|
46
|
+
* Revoke a verifiable credential.
|
|
47
|
+
*/
|
|
48
|
+
readonly VerifiableCredentialRevoke: "identity/verifiable-credential-revoke";
|
|
49
|
+
/**
|
|
50
|
+
* Unrevoke a verifiable credential.
|
|
51
|
+
*/
|
|
52
|
+
readonly VerifiableCredentialUnrevoke: "identity/verifiable-credential-unrevoke";
|
|
53
|
+
/**
|
|
54
|
+
* Create a verifiable presentation.
|
|
55
|
+
*/
|
|
56
|
+
readonly VerifiablePresentationCreate: "identity/verifiable-presentation-create";
|
|
57
|
+
/**
|
|
58
|
+
* Verify a verifiable presentation.
|
|
59
|
+
*/
|
|
60
|
+
readonly VerifiablePresentationVerify: "identity/verifiable-presentation-verify";
|
|
61
|
+
/**
|
|
62
|
+
* Create a proof.
|
|
63
|
+
*/
|
|
64
|
+
readonly ProofCreate: "identity/proof-create";
|
|
65
|
+
/**
|
|
66
|
+
* Verify a proof.
|
|
67
|
+
*/
|
|
68
|
+
readonly ProofVerify: "identity/proof-verify";
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* Union type of all identity span name string values.
|
|
72
|
+
*/
|
|
73
|
+
export type IdentitySpanNames = (typeof IdentitySpanNames)[keyof typeof IdentitySpanNames];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,172 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.2-next.10](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.9...identity-models-v0.9.2-next.10) (2026-08-20)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* tracing ([#205](https://github.com/iotaledger/twin-identity/issues/205)) ([add81ab](https://github.com/iotaledger/twin-identity/commit/add81ab4a258078c34ef0c57681d1675c81f8e2c))
|
|
9
|
+
|
|
10
|
+
## [0.9.2-next.9](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.8...identity-models-v0.9.2-next.9) (2026-08-14)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* add addAlsoKnownAs to identity connector ([#117](https://github.com/iotaledger/twin-identity/issues/117)) ([aa27cff](https://github.com/iotaledger/twin-identity/commit/aa27cff88e61e7c8c6e32aeb437fb01c6ee9f57a))
|
|
16
|
+
* add context id features ([#62](https://github.com/iotaledger/twin-identity/issues/62)) ([e02ecca](https://github.com/iotaledger/twin-identity/commit/e02ecca9c45a849104bfbf7bc18a1f44e6eea8a1))
|
|
17
|
+
* add context id long method ([#182](https://github.com/iotaledger/twin-identity/issues/182)) ([8e04625](https://github.com/iotaledger/twin-identity/commit/8e04625812cd3b8680ce837fadbb0bce046a5c2f))
|
|
18
|
+
* add expiration date option to vc creation ([73e05e1](https://github.com/iotaledger/twin-identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
|
|
19
|
+
* add identity remove ([eebc13f](https://github.com/iotaledger/twin-identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
|
|
20
|
+
* add idHelper class ([57c8bdb](https://github.com/iotaledger/twin-identity/commit/57c8bdb81efaa163b5e83f8a7f16f3764d12fd75))
|
|
21
|
+
* add optional jwt payload and headers to vc and vp tokens ([#135](https://github.com/iotaledger/twin-identity/issues/135)) ([aa1de0f](https://github.com/iotaledger/twin-identity/commit/aa1de0f63be95ff62bae3c699aabc85ea93d74c2))
|
|
22
|
+
* add proof to vcs and verify vs documents ([#103](https://github.com/iotaledger/twin-identity/issues/103)) ([b60bf0c](https://github.com/iotaledger/twin-identity/commit/b60bf0cb7d453d67574c5c0e4f769e67cf7cd6d1))
|
|
23
|
+
* add telemetry metrics ([#132](https://github.com/iotaledger/twin-identity/issues/132)) ([b51cd78](https://github.com/iotaledger/twin-identity/commit/b51cd7816905fd55e250035daf1b8f2047cba83d))
|
|
24
|
+
* add validate-locales ([04d74b4](https://github.com/iotaledger/twin-identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
|
|
25
|
+
* admin endpoints ([#199](https://github.com/iotaledger/twin-identity/issues/199)) ([da6c189](https://github.com/iotaledger/twin-identity/commit/da6c18963ed551451d919e36aedc1dd8b005a12f))
|
|
26
|
+
* common connector tests ([4f9642c](https://github.com/iotaledger/twin-identity/commit/4f9642ceb09843870909fc6819bf69fb20ef952a))
|
|
27
|
+
* eslint migration to flat config ([fd6246d](https://github.com/iotaledger/twin-identity/commit/fd6246d566280b6d5d10a108eb1e92c4b510f2f2))
|
|
28
|
+
* expanded cli methods ([#121](https://github.com/iotaledger/twin-identity/issues/121)) ([80a52b7](https://github.com/iotaledger/twin-identity/commit/80a52b779237cd633d1f2813fa976585cef6e551))
|
|
29
|
+
* health and key removal ([934391f](https://github.com/iotaledger/twin-identity/commit/934391f9307beda34bc594e3aa506137e3df631b))
|
|
30
|
+
* health and key removal ([#191](https://github.com/iotaledger/twin-identity/issues/191)) ([8504101](https://github.com/iotaledger/twin-identity/commit/8504101a7a08b2a042a4e59f666c245308527088))
|
|
31
|
+
* identity key separator use slash ([1319d0d](https://github.com/iotaledger/twin-identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
|
|
32
|
+
* remove auth generator ([#98](https://github.com/iotaledger/twin-identity/issues/98)) ([a8969e8](https://github.com/iotaledger/twin-identity/commit/a8969e85a5a2804abfc787406e2d12eb168dd978))
|
|
33
|
+
* separate vc verification routes with query and body ([ea7d891](https://github.com/iotaledger/twin-identity/commit/ea7d8910472150cf76dbd51e282625e70226d9b3))
|
|
34
|
+
* typescript 6 update ([e8806ad](https://github.com/iotaledger/twin-identity/commit/e8806ad6858c37be3c0f54c41cf654023773bef3))
|
|
35
|
+
* update did context handler definition ([02aa59a](https://github.com/iotaledger/twin-identity/commit/02aa59ae8100b1afb2325ea858411fc3e4d9d1e9))
|
|
36
|
+
* update framework core ([c824497](https://github.com/iotaledger/twin-identity/commit/c82449709af0215eb7af496cf687c93fb30b5ae0))
|
|
37
|
+
* use shared store mechanism ([#27](https://github.com/iotaledger/twin-identity/issues/27)) ([ce41f3f](https://github.com/iotaledger/twin-identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Bug Fixes
|
|
41
|
+
|
|
42
|
+
* didContextIdHandler tests ([dc7b555](https://github.com/iotaledger/twin-identity/commit/dc7b5558e47117475b7f1fa1686d3ed7e0906563))
|
|
43
|
+
* Import path and bump version ([#21](https://github.com/iotaledger/twin-identity/issues/21)) ([ccea845](https://github.com/iotaledger/twin-identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
|
|
44
|
+
* Install sdk-wasm ([#20](https://github.com/iotaledger/twin-identity/issues/20)) ([75ec14e](https://github.com/iotaledger/twin-identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
|
|
45
|
+
* query params force coercion ([d9347d2](https://github.com/iotaledger/twin-identity/commit/d9347d29d4a9cc58759f30f5d8526de864ea7522))
|
|
46
|
+
* stricter pathParam types ([a174cdf](https://github.com/iotaledger/twin-identity/commit/a174cdf0ca4272bee35fcf20ab7e8e4e17b8b6f4))
|
|
47
|
+
* use base64Url for tenant id short form so it doesn't include slash ([53b9e27](https://github.com/iotaledger/twin-identity/commit/53b9e27351f20e2689734581c252a23527657926))
|
|
48
|
+
* Use resolver component ([#22](https://github.com/iotaledger/twin-identity/issues/22)) ([d0b3a32](https://github.com/iotaledger/twin-identity/commit/d0b3a321c7f9f966d397a880d752e9f2c0a98a27))
|
|
49
|
+
|
|
50
|
+
## [0.9.2-next.8](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.7...identity-models-v0.9.2-next.8) (2026-08-14)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Features
|
|
54
|
+
|
|
55
|
+
* add addAlsoKnownAs to identity connector ([#117](https://github.com/iotaledger/twin-identity/issues/117)) ([aa27cff](https://github.com/iotaledger/twin-identity/commit/aa27cff88e61e7c8c6e32aeb437fb01c6ee9f57a))
|
|
56
|
+
* add context id features ([#62](https://github.com/iotaledger/twin-identity/issues/62)) ([e02ecca](https://github.com/iotaledger/twin-identity/commit/e02ecca9c45a849104bfbf7bc18a1f44e6eea8a1))
|
|
57
|
+
* add context id long method ([#182](https://github.com/iotaledger/twin-identity/issues/182)) ([8e04625](https://github.com/iotaledger/twin-identity/commit/8e04625812cd3b8680ce837fadbb0bce046a5c2f))
|
|
58
|
+
* add expiration date option to vc creation ([73e05e1](https://github.com/iotaledger/twin-identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
|
|
59
|
+
* add identity remove ([eebc13f](https://github.com/iotaledger/twin-identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
|
|
60
|
+
* add idHelper class ([57c8bdb](https://github.com/iotaledger/twin-identity/commit/57c8bdb81efaa163b5e83f8a7f16f3764d12fd75))
|
|
61
|
+
* add optional jwt payload and headers to vc and vp tokens ([#135](https://github.com/iotaledger/twin-identity/issues/135)) ([aa1de0f](https://github.com/iotaledger/twin-identity/commit/aa1de0f63be95ff62bae3c699aabc85ea93d74c2))
|
|
62
|
+
* add proof to vcs and verify vs documents ([#103](https://github.com/iotaledger/twin-identity/issues/103)) ([b60bf0c](https://github.com/iotaledger/twin-identity/commit/b60bf0cb7d453d67574c5c0e4f769e67cf7cd6d1))
|
|
63
|
+
* add telemetry metrics ([#132](https://github.com/iotaledger/twin-identity/issues/132)) ([b51cd78](https://github.com/iotaledger/twin-identity/commit/b51cd7816905fd55e250035daf1b8f2047cba83d))
|
|
64
|
+
* add validate-locales ([04d74b4](https://github.com/iotaledger/twin-identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
|
|
65
|
+
* admin endpoints ([#199](https://github.com/iotaledger/twin-identity/issues/199)) ([da6c189](https://github.com/iotaledger/twin-identity/commit/da6c18963ed551451d919e36aedc1dd8b005a12f))
|
|
66
|
+
* common connector tests ([4f9642c](https://github.com/iotaledger/twin-identity/commit/4f9642ceb09843870909fc6819bf69fb20ef952a))
|
|
67
|
+
* eslint migration to flat config ([fd6246d](https://github.com/iotaledger/twin-identity/commit/fd6246d566280b6d5d10a108eb1e92c4b510f2f2))
|
|
68
|
+
* expanded cli methods ([#121](https://github.com/iotaledger/twin-identity/issues/121)) ([80a52b7](https://github.com/iotaledger/twin-identity/commit/80a52b779237cd633d1f2813fa976585cef6e551))
|
|
69
|
+
* health and key removal ([934391f](https://github.com/iotaledger/twin-identity/commit/934391f9307beda34bc594e3aa506137e3df631b))
|
|
70
|
+
* health and key removal ([#191](https://github.com/iotaledger/twin-identity/issues/191)) ([8504101](https://github.com/iotaledger/twin-identity/commit/8504101a7a08b2a042a4e59f666c245308527088))
|
|
71
|
+
* identity key separator use slash ([1319d0d](https://github.com/iotaledger/twin-identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
|
|
72
|
+
* remove auth generator ([#98](https://github.com/iotaledger/twin-identity/issues/98)) ([a8969e8](https://github.com/iotaledger/twin-identity/commit/a8969e85a5a2804abfc787406e2d12eb168dd978))
|
|
73
|
+
* separate vc verification routes with query and body ([ea7d891](https://github.com/iotaledger/twin-identity/commit/ea7d8910472150cf76dbd51e282625e70226d9b3))
|
|
74
|
+
* typescript 6 update ([e8806ad](https://github.com/iotaledger/twin-identity/commit/e8806ad6858c37be3c0f54c41cf654023773bef3))
|
|
75
|
+
* update did context handler definition ([02aa59a](https://github.com/iotaledger/twin-identity/commit/02aa59ae8100b1afb2325ea858411fc3e4d9d1e9))
|
|
76
|
+
* update framework core ([c824497](https://github.com/iotaledger/twin-identity/commit/c82449709af0215eb7af496cf687c93fb30b5ae0))
|
|
77
|
+
* use shared store mechanism ([#27](https://github.com/iotaledger/twin-identity/issues/27)) ([ce41f3f](https://github.com/iotaledger/twin-identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### Bug Fixes
|
|
81
|
+
|
|
82
|
+
* didContextIdHandler tests ([dc7b555](https://github.com/iotaledger/twin-identity/commit/dc7b5558e47117475b7f1fa1686d3ed7e0906563))
|
|
83
|
+
* Import path and bump version ([#21](https://github.com/iotaledger/twin-identity/issues/21)) ([ccea845](https://github.com/iotaledger/twin-identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
|
|
84
|
+
* Install sdk-wasm ([#20](https://github.com/iotaledger/twin-identity/issues/20)) ([75ec14e](https://github.com/iotaledger/twin-identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
|
|
85
|
+
* query params force coercion ([d9347d2](https://github.com/iotaledger/twin-identity/commit/d9347d29d4a9cc58759f30f5d8526de864ea7522))
|
|
86
|
+
* stricter pathParam types ([a174cdf](https://github.com/iotaledger/twin-identity/commit/a174cdf0ca4272bee35fcf20ab7e8e4e17b8b6f4))
|
|
87
|
+
* use base64Url for tenant id short form so it doesn't include slash ([53b9e27](https://github.com/iotaledger/twin-identity/commit/53b9e27351f20e2689734581c252a23527657926))
|
|
88
|
+
* Use resolver component ([#22](https://github.com/iotaledger/twin-identity/issues/22)) ([d0b3a32](https://github.com/iotaledger/twin-identity/commit/d0b3a321c7f9f966d397a880d752e9f2c0a98a27))
|
|
89
|
+
|
|
90
|
+
## [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)
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
### Features
|
|
94
|
+
|
|
95
|
+
* admin endpoints ([#199](https://github.com/iotaledger/twin-identity/issues/199)) ([da6c189](https://github.com/iotaledger/twin-identity/commit/da6c18963ed551451d919e36aedc1dd8b005a12f))
|
|
96
|
+
|
|
97
|
+
## [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)
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### Miscellaneous Chores
|
|
101
|
+
|
|
102
|
+
* **identity-models:** Synchronize repo versions
|
|
103
|
+
|
|
104
|
+
## [0.9.2-next.5](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.4...identity-models-v0.9.2-next.5) (2026-08-10)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### Miscellaneous Chores
|
|
108
|
+
|
|
109
|
+
* **identity-models:** Synchronize repo versions
|
|
110
|
+
|
|
111
|
+
## [0.9.2-next.4](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.3...identity-models-v0.9.2-next.4) (2026-08-07)
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### Features
|
|
115
|
+
|
|
116
|
+
* health and key removal ([934391f](https://github.com/iotaledger/twin-identity/commit/934391f9307beda34bc594e3aa506137e3df631b))
|
|
117
|
+
* health and key removal ([#191](https://github.com/iotaledger/twin-identity/issues/191)) ([8504101](https://github.com/iotaledger/twin-identity/commit/8504101a7a08b2a042a4e59f666c245308527088))
|
|
118
|
+
|
|
119
|
+
## [0.9.2-next.3](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.2...identity-models-v0.9.2-next.3) (2026-08-03)
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### Miscellaneous Chores
|
|
123
|
+
|
|
124
|
+
* **identity-models:** Synchronize repo versions
|
|
125
|
+
|
|
126
|
+
## [0.9.2-next.2](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.1...identity-models-v0.9.2-next.2) (2026-07-30)
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### Miscellaneous Chores
|
|
130
|
+
|
|
131
|
+
* **identity-models:** Synchronize repo versions
|
|
132
|
+
|
|
133
|
+
## [0.9.2-next.1](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.2-next.0...identity-models-v0.9.2-next.1) (2026-07-29)
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### Features
|
|
137
|
+
|
|
138
|
+
* add addAlsoKnownAs to identity connector ([#117](https://github.com/iotaledger/twin-identity/issues/117)) ([aa27cff](https://github.com/iotaledger/twin-identity/commit/aa27cff88e61e7c8c6e32aeb437fb01c6ee9f57a))
|
|
139
|
+
* add context id features ([#62](https://github.com/iotaledger/twin-identity/issues/62)) ([e02ecca](https://github.com/iotaledger/twin-identity/commit/e02ecca9c45a849104bfbf7bc18a1f44e6eea8a1))
|
|
140
|
+
* add context id long method ([#182](https://github.com/iotaledger/twin-identity/issues/182)) ([8e04625](https://github.com/iotaledger/twin-identity/commit/8e04625812cd3b8680ce837fadbb0bce046a5c2f))
|
|
141
|
+
* add expiration date option to vc creation ([73e05e1](https://github.com/iotaledger/twin-identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
|
|
142
|
+
* add identity remove ([eebc13f](https://github.com/iotaledger/twin-identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
|
|
143
|
+
* add idHelper class ([57c8bdb](https://github.com/iotaledger/twin-identity/commit/57c8bdb81efaa163b5e83f8a7f16f3764d12fd75))
|
|
144
|
+
* add optional jwt payload and headers to vc and vp tokens ([#135](https://github.com/iotaledger/twin-identity/issues/135)) ([aa1de0f](https://github.com/iotaledger/twin-identity/commit/aa1de0f63be95ff62bae3c699aabc85ea93d74c2))
|
|
145
|
+
* add proof to vcs and verify vs documents ([#103](https://github.com/iotaledger/twin-identity/issues/103)) ([b60bf0c](https://github.com/iotaledger/twin-identity/commit/b60bf0cb7d453d67574c5c0e4f769e67cf7cd6d1))
|
|
146
|
+
* add telemetry metrics ([#132](https://github.com/iotaledger/twin-identity/issues/132)) ([b51cd78](https://github.com/iotaledger/twin-identity/commit/b51cd7816905fd55e250035daf1b8f2047cba83d))
|
|
147
|
+
* add validate-locales ([04d74b4](https://github.com/iotaledger/twin-identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
|
|
148
|
+
* common connector tests ([4f9642c](https://github.com/iotaledger/twin-identity/commit/4f9642ceb09843870909fc6819bf69fb20ef952a))
|
|
149
|
+
* eslint migration to flat config ([fd6246d](https://github.com/iotaledger/twin-identity/commit/fd6246d566280b6d5d10a108eb1e92c4b510f2f2))
|
|
150
|
+
* expanded cli methods ([#121](https://github.com/iotaledger/twin-identity/issues/121)) ([80a52b7](https://github.com/iotaledger/twin-identity/commit/80a52b779237cd633d1f2813fa976585cef6e551))
|
|
151
|
+
* identity key separator use slash ([1319d0d](https://github.com/iotaledger/twin-identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
|
|
152
|
+
* remove auth generator ([#98](https://github.com/iotaledger/twin-identity/issues/98)) ([a8969e8](https://github.com/iotaledger/twin-identity/commit/a8969e85a5a2804abfc787406e2d12eb168dd978))
|
|
153
|
+
* separate vc verification routes with query and body ([ea7d891](https://github.com/iotaledger/twin-identity/commit/ea7d8910472150cf76dbd51e282625e70226d9b3))
|
|
154
|
+
* typescript 6 update ([e8806ad](https://github.com/iotaledger/twin-identity/commit/e8806ad6858c37be3c0f54c41cf654023773bef3))
|
|
155
|
+
* update did context handler definition ([02aa59a](https://github.com/iotaledger/twin-identity/commit/02aa59ae8100b1afb2325ea858411fc3e4d9d1e9))
|
|
156
|
+
* update framework core ([c824497](https://github.com/iotaledger/twin-identity/commit/c82449709af0215eb7af496cf687c93fb30b5ae0))
|
|
157
|
+
* use shared store mechanism ([#27](https://github.com/iotaledger/twin-identity/issues/27)) ([ce41f3f](https://github.com/iotaledger/twin-identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### Bug Fixes
|
|
161
|
+
|
|
162
|
+
* didContextIdHandler tests ([dc7b555](https://github.com/iotaledger/twin-identity/commit/dc7b5558e47117475b7f1fa1686d3ed7e0906563))
|
|
163
|
+
* Import path and bump version ([#21](https://github.com/iotaledger/twin-identity/issues/21)) ([ccea845](https://github.com/iotaledger/twin-identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
|
|
164
|
+
* Install sdk-wasm ([#20](https://github.com/iotaledger/twin-identity/issues/20)) ([75ec14e](https://github.com/iotaledger/twin-identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
|
|
165
|
+
* query params force coercion ([d9347d2](https://github.com/iotaledger/twin-identity/commit/d9347d29d4a9cc58759f30f5d8526de864ea7522))
|
|
166
|
+
* stricter pathParam types ([a174cdf](https://github.com/iotaledger/twin-identity/commit/a174cdf0ca4272bee35fcf20ab7e8e4e17b8b6f4))
|
|
167
|
+
* use base64Url for tenant id short form so it doesn't include slash ([53b9e27](https://github.com/iotaledger/twin-identity/commit/53b9e27351f20e2689734581c252a23527657926))
|
|
168
|
+
* Use resolver component ([#22](https://github.com/iotaledger/twin-identity/issues/22)) ([d0b3a32](https://github.com/iotaledger/twin-identity/commit/d0b3a321c7f9f966d397a880d752e9f2c0a98a27))
|
|
169
|
+
|
|
3
170
|
## [0.9.1](https://github.com/iotaledger/twin-identity/compare/identity-models-v0.9.1...identity-models-v0.9.1) (2026-07-27)
|
|
4
171
|
|
|
5
172
|
|
|
@@ -70,6 +70,32 @@ Short form string.
|
|
|
70
70
|
|
|
71
71
|
***
|
|
72
72
|
|
|
73
|
+
### long() {#long}
|
|
74
|
+
|
|
75
|
+
> **long**(`value`): `string`
|
|
76
|
+
|
|
77
|
+
The long form version of the context ID, expanded from a short version.
|
|
78
|
+
|
|
79
|
+
#### Parameters
|
|
80
|
+
|
|
81
|
+
##### value
|
|
82
|
+
|
|
83
|
+
`string`
|
|
84
|
+
|
|
85
|
+
The short form context ID value.
|
|
86
|
+
|
|
87
|
+
#### Returns
|
|
88
|
+
|
|
89
|
+
`string`
|
|
90
|
+
|
|
91
|
+
The long form version of the context ID.
|
|
92
|
+
|
|
93
|
+
#### Implementation of
|
|
94
|
+
|
|
95
|
+
`IContextIdHandler.long`
|
|
96
|
+
|
|
97
|
+
***
|
|
98
|
+
|
|
73
99
|
### guard() {#guard}
|
|
74
100
|
|
|
75
101
|
> **guard**(`value`): `void`
|
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)
|
|
@@ -56,6 +61,8 @@
|
|
|
56
61
|
## Type Aliases
|
|
57
62
|
|
|
58
63
|
- [IdentityMetricIds](type-aliases/IdentityMetricIds.md)
|
|
64
|
+
- [IdentitySpanAttributes](type-aliases/IdentitySpanAttributes.md)
|
|
65
|
+
- [IdentitySpanNames](type-aliases/IdentitySpanNames.md)
|
|
59
66
|
|
|
60
67
|
## Variables
|
|
61
68
|
|
|
@@ -64,3 +71,5 @@
|
|
|
64
71
|
- [IdentityResolverConnectorFactory](variables/IdentityResolverConnectorFactory.md)
|
|
65
72
|
- [IdentityMetricIds](variables/IdentityMetricIds.md)
|
|
66
73
|
- [IdentityMetrics](variables/IdentityMetrics.md)
|
|
74
|
+
- [IdentitySpanAttributes](variables/IdentitySpanAttributes.md)
|
|
75
|
+
- [IdentitySpanNames](variables/IdentitySpanNames.md)
|
|
@@ -38,7 +38,7 @@ The created identity document.
|
|
|
38
38
|
|
|
39
39
|
### identityRemove() {#identityremove}
|
|
40
40
|
|
|
41
|
-
> **identityRemove**(`identity`, `controller?`): `Promise`\<`void`\>
|
|
41
|
+
> **identityRemove**(`identity`, `options?`, `controller?`): `Promise`\<`void`\>
|
|
42
42
|
|
|
43
43
|
Remove an identity.
|
|
44
44
|
|
|
@@ -50,6 +50,16 @@ Remove an identity.
|
|
|
50
50
|
|
|
51
51
|
The id of the document to remove.
|
|
52
52
|
|
|
53
|
+
##### options?
|
|
54
|
+
|
|
55
|
+
Optional settings.
|
|
56
|
+
|
|
57
|
+
###### removeKeys?
|
|
58
|
+
|
|
59
|
+
`boolean`
|
|
60
|
+
|
|
61
|
+
Also remove any associated private keys from the vault.
|
|
62
|
+
|
|
53
63
|
##### controller?
|
|
54
64
|
|
|
55
65
|
`string`
|
|
@@ -114,7 +124,7 @@ NotSupportedError if the platform does not support multiple keys.
|
|
|
114
124
|
|
|
115
125
|
### verificationMethodRemove() {#verificationmethodremove}
|
|
116
126
|
|
|
117
|
-
> **verificationMethodRemove**(`verificationMethodId`, `controller?`): `Promise`\<`void`\>
|
|
127
|
+
> **verificationMethodRemove**(`verificationMethodId`, `options?`, `controller?`): `Promise`\<`void`\>
|
|
118
128
|
|
|
119
129
|
Remove a verification method from the document.
|
|
120
130
|
|
|
@@ -126,6 +136,16 @@ Remove a verification method from the document.
|
|
|
126
136
|
|
|
127
137
|
The id of the verification method.
|
|
128
138
|
|
|
139
|
+
##### options?
|
|
140
|
+
|
|
141
|
+
Optional settings.
|
|
142
|
+
|
|
143
|
+
###### removeKeys?
|
|
144
|
+
|
|
145
|
+
`boolean`
|
|
146
|
+
|
|
147
|
+
Also remove any associated private key from the vault.
|
|
148
|
+
|
|
129
149
|
##### controller?
|
|
130
150
|
|
|
131
151
|
`string`
|
|
@@ -32,7 +32,7 @@ The created document.
|
|
|
32
32
|
|
|
33
33
|
### removeDocument() {#removedocument}
|
|
34
34
|
|
|
35
|
-
> **removeDocument**(`controller`, `documentId`): `Promise`\<`void`\>
|
|
35
|
+
> **removeDocument**(`controller`, `documentId`, `options?`): `Promise`\<`void`\>
|
|
36
36
|
|
|
37
37
|
Remove a document.
|
|
38
38
|
|
|
@@ -50,6 +50,16 @@ The controller of the identity who can make changes.
|
|
|
50
50
|
|
|
51
51
|
The id of the document to remove.
|
|
52
52
|
|
|
53
|
+
##### options?
|
|
54
|
+
|
|
55
|
+
Optional settings.
|
|
56
|
+
|
|
57
|
+
###### removeKeys?
|
|
58
|
+
|
|
59
|
+
`boolean`
|
|
60
|
+
|
|
61
|
+
Also remove any associated private keys from the vault.
|
|
62
|
+
|
|
53
63
|
#### Returns
|
|
54
64
|
|
|
55
65
|
`Promise`\<`void`\>
|
|
@@ -108,7 +118,7 @@ NotSupportedError if the platform does not support multiple keys.
|
|
|
108
118
|
|
|
109
119
|
### removeVerificationMethod() {#removeverificationmethod}
|
|
110
120
|
|
|
111
|
-
> **removeVerificationMethod**(`controller`, `verificationMethodId`): `Promise`\<`void`\>
|
|
121
|
+
> **removeVerificationMethod**(`controller`, `verificationMethodId`, `options?`): `Promise`\<`void`\>
|
|
112
122
|
|
|
113
123
|
Remove a verification method from the document.
|
|
114
124
|
|
|
@@ -126,6 +136,16 @@ The controller of the identity who can make changes.
|
|
|
126
136
|
|
|
127
137
|
The id of the verification method.
|
|
128
138
|
|
|
139
|
+
##### options?
|
|
140
|
+
|
|
141
|
+
Optional settings.
|
|
142
|
+
|
|
143
|
+
###### removeKeys?
|
|
144
|
+
|
|
145
|
+
`boolean`
|
|
146
|
+
|
|
147
|
+
Also remove any associated private key from the vault.
|
|
148
|
+
|
|
129
149
|
#### Returns
|
|
130
150
|
|
|
131
151
|
`Promise`\<`void`\>
|
|
@@ -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.
|