Integrate enmeshed

IdentityMetadata is used to store arbitrary auxiliary metadata related to an Identity within the Connector. This use case creates or updates an IdentityMetadata that relates to the Identity whose address is specified within the reference property of the IdentityMetadata. IdentityMetadata may only be created or updated for a peer of a Relationship or the own Identity, or in other words, sufficiently familiar Identities. If there is no IdentityMetadata for a given reference and key combination, a new IdentityMetadata will be created. Otherwise, the existing IdentityMetadata is updated inplace with the new value provided. Therefore, there can be at most one IdentityMetadata per reference and key combination. In particular, there can be at most one IdentityMetadata without a key for each Identity.

Parameters

  • reference is the address of the Identity about which metadata is to be created or updated.
  • Optionally, a key can be specified as an additional identifier to store and distinguish multiple IdentityMetadata for the same Identity.
  • value is the arbitrary metadata to be stored about the Identity. It must be compatible with the JSON data types string, number, boolean, object, array and null.

On Success

  • Returns the created or updated IdentityMetadata.

On Failure

  • The reference resolves neither to the address of a peer of a Relationship nor the address of the own Identity.

How to execute this use case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use case. This use case can be executed with the REST API of the Connector which you can Access the Connector.
Corresponding interactive API docs excerpt: