From a5c1f9376595bc4ca681a14807cadb79e4a1eac9 Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Mon, 16 Dec 2024 16:50:57 +0000 Subject: [PATCH] feat: add passwordProtection property to RelationshipTemplate --- _docs_integrate/data-model-overview.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index 028e7db38..640ab0c10 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -81,8 +81,20 @@ A RelationshipTemplate serves two purposes: | expiresAt | `string` | {% include descr_expiresAt class="RelationshipTemplate" %} | will be encrypted before sent to the Backbone | | maxNumberOfAllocations | `number` \| `undefined` | Can be set to limit the number of allocations of this RelationshipTemplate. A RelationshipTemplate is allocated by another Identity when it is first retrieved by it from the Backbone. After this value is reached, the Backbone rejects each request of any new Identity that wants to retrieve it. Identities that already allocated it will still be able to retrieve it. | | | forIdentity | `string` \| `undefined` | Can be set to an enmeshed address. If set, then only the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) with that `address` can retrieve the RelationshipTemplate from the Backbone. | | +| passwordProtection | [`PasswordProtection`](#passwordprotection) \| `undefined` | Information about whether the RelationshipTemplate is protected by a password or not. | | | truncatedReference | `string` | {% include descr_truncatedReference class="RelationshipTemplate" %} | saved only locally | +### PasswordProtection + +A [RelationshipTemplate](#relationshiptemplate) can be protected by a password to ensure that it is protected from unauthorized access. +Indeed, in order for a peer to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to the creator of the password protected RelationshipTemplate, it must enter the correct password when loading the RelationshipTemplate. +Whether a RelationshipTemplate is protected by a password or not is recorded within its `passwordProtection` property. + +| Name | Type | Description | Remarks | +| ------------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| password | `string` | The password of the RelationshipTemplate. | | +| passwordIsPin | `true` \| `undefined` | If the password of the RelationshipTemplate consists only of numbers, the value of the `passwordIsPin` property can be set to `true`. In this case, the password is interpreted as a pin and a corresponding input field is displayed in the UI of the App when the pin needs to be entered. However, if the value is `undefined`, a regular input field for entering the password is displayed regardless of whether the password could also be interpreted as a pin because it only consists of numbers. | | + ## Relationship A Relationship between two Identities is the prerequisite for them to exchange Messages. If there is no Relationship, the Backbone blocks all Messages that are tried to be sent. This ensures that you only receive Messages from Identities you know, so you are protected from any harmful Messages like spam or phishing mails.