feat: add IdentityMetadata to Data Model Overview

nmshd · Dec 20, 2024 · 8632086 · 8632086
1 parent fc3e933
commit 8632086
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md
@@ -1054,3 +1054,16 @@ The parameters to accept a ReadAttributeRequestItem with a new Attribute.
 | ------------ | ---------------------------------------------- | -------------------------------------------------- |
 | accept       | `"true"`                                       | The only possible value here is the string "true". |
 | newAttribute | `IdentityAttribute` \| `RelationshipAttribute` | The new Attribute.                                 |
+
+## IdentityMetadata
+
+An Integrator of a Connector should be able to store arbitrary auxiliary metadata related to an [Identity](#identity) within the Connector.
+The usual CRUD operations for handling IdentityMetadata are provided by different [use cases]({% link _docs_integrate/use-cases.md %}).
+To be more precise, there is the [Upsert IdentityMetadata]({% link _docs_use-cases/use-case-consumption-upsert-identitymetadata.md %}) use case for creating and updating IdentityMetadata, as well as the [Get IdentityMetadata]({% link _docs_use-cases/use-case-consumption-get-identitymetadata.md %}) use case and the [Delete IdentityMetadata]({% link _docs_use-cases/use-case-consumption-delete-identitymetadata.md %}) use case.
+
+| Name      | Type                    | Description                                                  | Remarks            |
+| --------- | ----------------------- | ------------------------------------------------------------ | ------------------ |
+| id        | `string`                | {% include descr_id class="IdentityMetadata" prefix="IDM" %} |                    |
+| reference | `string`                | Reference of IdentityMetadata.                               | saved only locally |
+| key       | `string` \| `undefined` | Optional key of IdentityMetadata.                            | saved only locally |
+| value     | `string`                | Value of IdentityMetadata.                                   | saved only locally |
diff --git a/_includes/descr_id b/_includes/descr_id
@@ -1 +1 @@
-Unique identifier of this object. <br>*Remark: the ID of each {{ include.class }} starts with the letters "{{ include.prefix }}". This way you can tell apart a {{ include.class }} ID from any other ID just by looking at the prefix.*
+Unique identifier of this object. <br>*Remark: The ID of each {{ include.class }} starts with the letters `"{{ include.prefix }}"`. This way you can tell apart such an ID from any other ID just by looking at the prefix.*
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		Unique identifier of this object. <br>Remark: the ID of each {{ include.class }} starts with the letters "{{ include.prefix }}". This way you can tell apart a {{ include.class }} ID from any other ID just by looking at the prefix.
		Unique identifier of this object. <br>Remark: The ID of each {{ include.class }} starts with the letters `"{{ include.prefix }}"`. This way you can tell apart such an ID from any other ID just by looking at the prefix.