@twin.org/api-auth-entity-storage-models 0.0.3-next.4 → 0.0.3-next.40

package/docs/changelog.md

@@ -1,193 +1,456 @@
-# @twin.org/api-auth-entity-storage-models - Changelog
+# Changelog
 
-## [0.0.3-next.4](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.3...api-auth-entity-storage-models-v0.0.3-next.4) (2025-11-14)
+## [0.0.3-next.40](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.39...api-auth-entity-storage-models-v0.0.3-next.40) (2026-06-04)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.39](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.38...api-auth-entity-storage-models-v0.0.3-next.39) (2026-06-02)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.38](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.37...api-auth-entity-storage-models-v0.0.3-next.38) (2026-05-28)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.37](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.36...api-auth-entity-storage-models-v0.0.3-next.37) (2026-05-22)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.36](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.35...api-auth-entity-storage-models-v0.0.3-next.36) (2026-05-22)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.35](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.34...api-auth-entity-storage-models-v0.0.3-next.35) (2026-05-21)
+
+
+### Features
+
+* user partitioning ([#126](https://github.com/iotaledger/twin-api/issues/126)) ([6bf0da3](https://github.com/iotaledger/twin-api/commit/6bf0da3c42406c9838e80e0ddd6b21f5c64aac90))
+
+## [0.0.3-next.34](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.33...api-auth-entity-storage-models-v0.0.3-next.34) (2026-05-19)
+
+
+### Features
+
+* update dependencies ([32b8cd2](https://github.com/iotaledger/twin-api/commit/32b8cd20353119dd1998e293d54063cf4d9ecc29))
+
+## [0.0.3-next.33](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.32...api-auth-entity-storage-models-v0.0.3-next.33) (2026-05-11)
+
+
+### Features
+
+* typescript 6 update ([78d2aa0](https://github.com/iotaledger/twin-api/commit/78d2aa00902f79b61973079b798b87ec05f18a8b))
+
+## [0.0.3-next.32](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.31...api-auth-entity-storage-models-v0.0.3-next.32) (2026-05-07)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.31](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.30...api-auth-entity-storage-models-v0.0.3-next.31) (2026-05-06)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.30](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.29...api-auth-entity-storage-models-v0.0.3-next.30) (2026-05-05)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.29](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.28...api-auth-entity-storage-models-v0.0.3-next.29) (2026-05-01)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.28](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.27...api-auth-entity-storage-models-v0.0.3-next.28) (2026-04-30)
+
+
+### Bug Fixes
+
+* change logout and refresh routes from GET to POST ([#111](https://github.com/iotaledger/twin-api/issues/111)) ([cb8b64b](https://github.com/iotaledger/twin-api/commit/cb8b64b6507f9991baa78a663de2e84269695c82))
+
+## [0.0.3-next.27](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.26...api-auth-entity-storage-models-v0.0.3-next.27) (2026-04-23)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.26](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.25...api-auth-entity-storage-models-v0.0.3-next.26) (2026-04-22)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.25](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.24...api-auth-entity-storage-models-v0.0.3-next.25) (2026-04-14)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.24](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.23...api-auth-entity-storage-models-v0.0.3-next.24) (2026-04-14)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.23](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.22...api-auth-entity-storage-models-v0.0.3-next.23) (2026-04-14)
+
+
+### Features
+
+* auth enhancements ([#93](https://github.com/iotaledger/twin-api/issues/93)) ([921a50c](https://github.com/iotaledger/twin-api/commit/921a50cd89d26e530a6be6174a5a803060fa0eb6))
+
+## [0.0.3-next.22](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.21...api-auth-entity-storage-models-v0.0.3-next.22) (2026-03-27)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.21](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.20...api-auth-entity-storage-models-v0.0.3-next.21) (2026-03-11)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.20](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.19...api-auth-entity-storage-models-v0.0.3-next.20) (2026-02-09)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.19](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.18...api-auth-entity-storage-models-v0.0.3-next.19) (2026-02-06)
+
+
+### Features
+
+* user admin service ([#77](https://github.com/iotaledger/twin-api/issues/77)) ([c8491df](https://github.com/iotaledger/twin-api/commit/c8491df7b07c1f45560c8a78c6adc806d0ececbb))
+
+## [0.0.3-next.18](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.17...api-auth-entity-storage-models-v0.0.3-next.18) (2026-02-04)
+
+
+### Features
+
+* tenant api and scopes ([#75](https://github.com/iotaledger/twin-api/issues/75)) ([c663141](https://github.com/iotaledger/twin-api/commit/c663141091e8974d769f8f9904ecdab009ebd083))
+
+## [0.0.3-next.17](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.16...api-auth-entity-storage-models-v0.0.3-next.17) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.16](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.15...api-auth-entity-storage-models-v0.0.3-next.16) (2026-01-26)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.15](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.14...api-auth-entity-storage-models-v0.0.3-next.15) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.13...api-auth-entity-storage-models-v0.0.3-next.14) (2026-01-20)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.13](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.12...api-auth-entity-storage-models-v0.0.3-next.13) (2026-01-19)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.12](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.11...api-auth-entity-storage-models-v0.0.3-next.12) (2026-01-12)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.11](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.10...api-auth-entity-storage-models-v0.0.3-next.11) (2026-01-08)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.10](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.9...api-auth-entity-storage-models-v0.0.3-next.10) (2026-01-05)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.8...api-auth-entity-storage-models-v0.0.3-next.9) (2026-01-05)
+
+
+### Features
+
+* add context id features ([#42](https://github.com/iotaledger/twin-api/issues/42)) ([0186055](https://github.com/iotaledger/twin-api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/iotaledger/twin-api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* improve description ([d28185c](https://github.com/iotaledger/twin-api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* improve socket route logging ([b8d9519](https://github.com/iotaledger/twin-api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* modify authHeaderProcessor to retain token in response body ([#53](https://github.com/iotaledger/twin-api/issues/53)) ([5d9ae76](https://github.com/iotaledger/twin-api/commit/5d9ae76b5b52a8e10dac391b2d5784638a186583))
+* remove unused namespace ([08478f2](https://github.com/iotaledger/twin-api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.7...api-auth-entity-storage-models-v0.0.3-next.8) (2025-12-17)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.6...api-auth-entity-storage-models-v0.0.3-next.7) (2025-11-26)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.5...api-auth-entity-storage-models-v0.0.3-next.6) (2025-11-20)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.4...api-auth-entity-storage-models-v0.0.3-next.5) (2025-11-14)
+
+
+### Miscellaneous Chores
+
+* **api-auth-entity-storage-models:** Synchronize repo versions
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.3...api-auth-entity-storage-models-v0.0.3-next.4) (2025-11-14)
 
 
 ### Features
 
-* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
-* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
-* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
-* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
-* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
-* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
-* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
-* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* add context id features ([#42](https://github.com/iotaledger/twin-api/issues/42)) ([0186055](https://github.com/iotaledger/twin-api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/iotaledger/twin-api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* improve description ([d28185c](https://github.com/iotaledger/twin-api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* improve socket route logging ([b8d9519](https://github.com/iotaledger/twin-api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* remove unused namespace ([08478f2](https://github.com/iotaledger/twin-api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
 
-## [0.0.3-next.3](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.2...api-auth-entity-storage-models-v0.0.3-next.3) (2025-11-14)
+## [0.0.3-next.3](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.2...api-auth-entity-storage-models-v0.0.3-next.3) (2025-11-14)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.3-next.2](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.1...api-auth-entity-storage-models-v0.0.3-next.2) (2025-11-12)
+## [0.0.3-next.2](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.1...api-auth-entity-storage-models-v0.0.3-next.2) (2025-11-12)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.3-next.1](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.3-next.0...api-auth-entity-storage-models-v0.0.3-next.1) (2025-11-10)
+## [0.0.3-next.1](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.3-next.0...api-auth-entity-storage-models-v0.0.3-next.1) (2025-11-10)
 
 
 ### Features
 
-* add context id features ([#42](https://github.com/twinfoundation/api/issues/42)) ([0186055](https://github.com/twinfoundation/api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
-* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
-* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
-* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
-* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
-* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
-* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
-* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* add context id features ([#42](https://github.com/iotaledger/twin-api/issues/42)) ([0186055](https://github.com/iotaledger/twin-api/commit/0186055c48afde842a4254b4df9ac9249c40fe40))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/iotaledger/twin-api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* improve description ([d28185c](https://github.com/iotaledger/twin-api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* improve socket route logging ([b8d9519](https://github.com/iotaledger/twin-api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* remove unused namespace ([08478f2](https://github.com/iotaledger/twin-api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
 
-## [0.0.2-next.13](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.12...api-auth-entity-storage-models-v0.0.2-next.13) (2025-10-09)
+## [0.0.2-next.13](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.12...api-auth-entity-storage-models-v0.0.2-next.13) (2025-10-09)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.2-next.12](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.11...api-auth-entity-storage-models-v0.0.2-next.12) (2025-10-09)
+## [0.0.2-next.12](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.11...api-auth-entity-storage-models-v0.0.2-next.12) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([cdba610](https://github.com/twinfoundation/api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
+* add validate-locales ([cdba610](https://github.com/iotaledger/twin-api/commit/cdba610a0acb5022d2e3ce729732e6646a297e5e))
 
-## [0.0.2-next.11](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.10...api-auth-entity-storage-models-v0.0.2-next.11) (2025-09-29)
+## [0.0.2-next.11](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.10...api-auth-entity-storage-models-v0.0.2-next.11) (2025-09-29)
 
 
 ### Features
 
-* update IComponent signatures ([915ce37](https://github.com/twinfoundation/api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
+* update IComponent signatures ([915ce37](https://github.com/iotaledger/twin-api/commit/915ce37712326ab4aa6869c350eabaa4622e8430))
 
-## [0.0.2-next.10](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.9...api-auth-entity-storage-models-v0.0.2-next.10) (2025-09-23)
+## [0.0.2-next.10](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.9...api-auth-entity-storage-models-v0.0.2-next.10) (2025-09-23)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.2-next.9](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.8...api-auth-entity-storage-models-v0.0.2-next.9) (2025-08-29)
+## [0.0.2-next.9](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.8...api-auth-entity-storage-models-v0.0.2-next.9) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([0dd5820](https://github.com/twinfoundation/api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
+* eslint migration to flat config ([0dd5820](https://github.com/iotaledger/twin-api/commit/0dd5820e3af97350fd08b8d226f4a6c1a9246805))
 
-## [0.0.2-next.8](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.7...api-auth-entity-storage-models-v0.0.2-next.8) (2025-08-21)
+## [0.0.2-next.8](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.7...api-auth-entity-storage-models-v0.0.2-next.8) (2025-08-21)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.2-next.7](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.6...api-auth-entity-storage-models-v0.0.2-next.7) (2025-08-20)
+## [0.0.2-next.7](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.6...api-auth-entity-storage-models-v0.0.2-next.7) (2025-08-20)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.2-next.6](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.5...api-auth-entity-storage-models-v0.0.2-next.6) (2025-08-19)
+## [0.0.2-next.6](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.5...api-auth-entity-storage-models-v0.0.2-next.6) (2025-08-19)
 
 
 ### Features
 
-* update framework core ([d8eebf2](https://github.com/twinfoundation/api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
+* update framework core ([d8eebf2](https://github.com/iotaledger/twin-api/commit/d8eebf267fa2a0abaa84e58590496e9d20490cfa))
 
-## [0.0.2-next.5](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.4...api-auth-entity-storage-models-v0.0.2-next.5) (2025-07-25)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.4...api-auth-entity-storage-models-v0.0.2-next.5) (2025-07-25)
 
 
 ### Features
 
-* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
-* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
-* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
-* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/iotaledger/twin-api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* improve description ([d28185c](https://github.com/iotaledger/twin-api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* improve socket route logging ([b8d9519](https://github.com/iotaledger/twin-api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* remove unused namespace ([08478f2](https://github.com/iotaledger/twin-api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
 
-## [0.0.2-next.4](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.3...api-auth-entity-storage-models-v0.0.2-next.4) (2025-07-25)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.3...api-auth-entity-storage-models-v0.0.2-next.4) (2025-07-25)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.2-next.3](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.2...api-auth-entity-storage-models-v0.0.2-next.3) (2025-07-24)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.2...api-auth-entity-storage-models-v0.0.2-next.3) (2025-07-24)
 
 
 ### Features
 
-* remove unused namespace ([08478f2](https://github.com/twinfoundation/api/commit/08478f27efda9beb0271fdb22f6972e918361965))
+* remove unused namespace ([08478f2](https://github.com/iotaledger/twin-api/commit/08478f27efda9beb0271fdb22f6972e918361965))
 
-## [0.0.2-next.2](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.1...api-auth-entity-storage-models-v0.0.2-next.2) (2025-07-17)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.1...api-auth-entity-storage-models-v0.0.2-next.2) (2025-07-17)
 
 
 ### Features
 
-* improve socket route logging ([b8d9519](https://github.com/twinfoundation/api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
+* improve socket route logging ([b8d9519](https://github.com/iotaledger/twin-api/commit/b8d95199f838ac6ba9f45c30ef7c4e613201ff53))
 
-## [0.0.2-next.1](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.2-next.0...api-auth-entity-storage-models-v0.0.2-next.1) (2025-07-08)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.2-next.0...api-auth-entity-storage-models-v0.0.2-next.1) (2025-07-08)
 
 
 ### Features
 
-* add json-ld mime type processor and auth admin component ([8861791](https://github.com/twinfoundation/api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
-* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* add json-ld mime type processor and auth admin component ([8861791](https://github.com/iotaledger/twin-api/commit/88617916e23bfbca023dbae1976fe421983a02ff))
+* improve description ([d28185c](https://github.com/iotaledger/twin-api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
 
 ## 0.0.1 (2025-07-03)
 
 
 ### Features
 
-* release to production ([70ee2d5](https://github.com/twinfoundation/api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
+* release to production ([70ee2d5](https://github.com/iotaledger/twin-api/commit/70ee2d56a1dc9537d7c9c154d4cb78a235678a3a))
 
-## [0.0.1-next.36](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.35...api-auth-entity-storage-models-v0.0.1-next.36) (2025-06-17)
+## [0.0.1-next.36](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.1-next.35...api-auth-entity-storage-models-v0.0.1-next.36) (2025-06-17)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.1-next.35](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.34...api-auth-entity-storage-models-v0.0.1-next.35) (2025-06-11)
+## [0.0.1-next.35](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.1-next.34...api-auth-entity-storage-models-v0.0.1-next.35) (2025-06-11)
 
 
 ### Features
 
-* update dependencies ([1171dc4](https://github.com/twinfoundation/api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
+* update dependencies ([1171dc4](https://github.com/iotaledger/twin-api/commit/1171dc416a9481737f6a640e3cf30145768f37e9))
 
-## [0.0.1-next.34](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.33...api-auth-entity-storage-models-v0.0.1-next.34) (2025-05-27)
+## [0.0.1-next.34](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.1-next.33...api-auth-entity-storage-models-v0.0.1-next.34) (2025-05-27)
 
 
 ### Miscellaneous Chores
 
 * **api-auth-entity-storage-models:** Synchronize repo versions
 
-## [0.0.1-next.33](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.32...api-auth-entity-storage-models-v0.0.1-next.33) (2025-04-17)
+## [0.0.1-next.33](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.1-next.32...api-auth-entity-storage-models-v0.0.1-next.33) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#19](https://github.com/twinfoundation/api/issues/19)) ([32116df](https://github.com/twinfoundation/api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
+* use shared store mechanism ([#19](https://github.com/iotaledger/twin-api/issues/19)) ([32116df](https://github.com/iotaledger/twin-api/commit/32116df3b4380a30137f5056f242a5c99afa2df9))
 
-## [0.0.1-next.32](https://github.com/twinfoundation/api/compare/api-auth-entity-storage-models-v0.0.1-next.31...api-auth-entity-storage-models-v0.0.1-next.32) (2025-03-28)
+## [0.0.1-next.32](https://github.com/iotaledger/twin-api/compare/api-auth-entity-storage-models-v0.0.1-next.31...api-auth-entity-storage-models-v0.0.1-next.32) (2025-03-28)
 
 
 ### Features
 
-* improve description ([d28185c](https://github.com/twinfoundation/api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
+* improve description ([d28185c](https://github.com/iotaledger/twin-api/commit/d28185c799a97455fee72fb23c744c8e71325f0b))
 
 ## v0.0.1-next.31
 

package/docs/examples.md

@@ -1 +1,80 @@
-# @twin.org/api-auth-entity-storage-models - Examples
+# Auth Entity Storage Models Examples
+
+Use these snippets to shape request and response data consistently across sign-in flows, admin operations, and token refresh handling.
+
+## Authentication Requests
+
+```typescript
+import type {
+  ILoginRequest,
+  IRefreshTokenRequest,
+  IUpdatePasswordRequest
+} from '@twin.org/api-auth-entity-storage-models';
+
+const loginRequest: ILoginRequest = {
+  body: {
+    email: 'alice@example.org',
+    password: 'correct-horse-battery-staple'
+  }
+};
+
+const refreshRequest: IRefreshTokenRequest = {
+  body: {
+    token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.refresh'
+  }
+};
+
+const updatePasswordRequest: IUpdatePasswordRequest = {
+  body: {
+    currentPassword: 'old-password',
+    newPassword: 'new-password-2026'
+  }
+};
+
+console.log(loginRequest.body.email); // alice@example.org
+```
+
+## Admin User Models
+
+```typescript
+import type {
+  IAdminUserCreateRequest,
+  IAdminUserUpdateRequest
+} from '@twin.org/api-auth-entity-storage-models';
+
+const createRequest: IAdminUserCreateRequest = {
+  body: {
+    email: 'bob@example.org',
+    password: 'initial-password',
+    userIdentity: 'did:example:bob',
+    organizationIdentity: 'did:example:org',
+    scope: ['admin', 'auditor']
+  }
+};
+
+const updateRequest: IAdminUserUpdateRequest = {
+  pathParams: {
+    email: 'bob@example.org'
+  },
+  body: {
+    userIdentity: 'did:example:bob:ops',
+    scope: ['admin']
+  }
+};
+
+console.log(createRequest.body.scope.length); // 2
+```
+
+## Authentication Responses
+
+```typescript
+import type { ILoginResponse } from '@twin.org/api-auth-entity-storage-models';
+
+const loginResponse: ILoginResponse = {
+  body: {
+    expiry: 3600
+  }
+};
+
+console.log(loginResponse.body.expiry); // 3600
+```

package/docs/reference/index.md

@@ -3,10 +3,34 @@
 ## Interfaces
 
 - [IAuthenticationAdminComponent](interfaces/IAuthenticationAdminComponent.md)
+- [IAuthenticationAuditComponent](interfaces/IAuthenticationAuditComponent.md)
+- [IAuthenticationAuditEntry](interfaces/IAuthenticationAuditEntry.md)
 - [IAuthenticationComponent](interfaces/IAuthenticationComponent.md)
+- [IAuthenticationRateActionConfig](interfaces/IAuthenticationRateActionConfig.md)
+- [IAuthenticationRateComponent](interfaces/IAuthenticationRateComponent.md)
+- [IAuthenticationUser](interfaces/IAuthenticationUser.md)
+- [IAuthenticationUserSecure](interfaces/IAuthenticationUserSecure.md)
+- [IAdminUserCreateRequest](interfaces/IAdminUserCreateRequest.md)
+- [IAdminUserGetByIdentityRequest](interfaces/IAdminUserGetByIdentityRequest.md)
+- [IAdminUserGetRequest](interfaces/IAdminUserGetRequest.md)
+- [IAdminUserGetResponse](interfaces/IAdminUserGetResponse.md)
+- [IAdminUserRemoveRequest](interfaces/IAdminUserRemoveRequest.md)
+- [IAdminUserUpdatePasswordRequest](interfaces/IAdminUserUpdatePasswordRequest.md)
+- [IAdminUserUpdateRequest](interfaces/IAdminUserUpdateRequest.md)
+- [IAuditCreateRequest](interfaces/IAuditCreateRequest.md)
+- [IAuditQueryRequest](interfaces/IAuditQueryRequest.md)
+- [IAuditQueryResponse](interfaces/IAuditQueryResponse.md)
 - [ILoginRequest](interfaces/ILoginRequest.md)
 - [ILoginResponse](interfaces/ILoginResponse.md)
 - [ILogoutRequest](interfaces/ILogoutRequest.md)
 - [IRefreshTokenRequest](interfaces/IRefreshTokenRequest.md)
 - [IRefreshTokenResponse](interfaces/IRefreshTokenResponse.md)
 - [IUpdatePasswordRequest](interfaces/IUpdatePasswordRequest.md)
+
+## Type Aliases
+
+- [AuthAuditEvent](type-aliases/AuthAuditEvent.md)
+
+## Variables
+
+- [AuthAuditEvent](variables/AuthAuditEvent.md)