Integrate enmeshed

Creates a RelationshipTemplate with the given parameters and submits it to the Backbone for other Identities to use.

A RelationshipTemplate can be used by any party to either initiate a Relationship with the current Identity or retrieve a Request from an existing Relationship by a side-channel.

Parameters

  • expiresAt is the ISODateTime the RelationshipTemplate expires at. This should be set as small as possible and cannot be in the past.
  • content describes the structure of the RelationshipTemplate. If an enmeshed App user shall receive this RelationshipTemplate, a RelationshipTemplateContent is required as structure, otherwise an ArbitraryRelationshipTemplateContent containing any data can be used.
  • maxNumberOfAllocations is the number of times the RelationshipTemplate can be accessed by different Identities to initiate a Relationship. The Backbone returns an error, if one accesses a RelationshipTemplate with no allocations left. Accessing the same RelationshipTemplate with the same Identity multiple times doesn’t affect the number of allocations. The allocation counts, even if the Identity does not accept the RelationshipTemplate by discarding it.
  • forIdentity can be set to an enmeshed address. If set, only the Identity with that address can access the RelationshipTemplate.
  • passwordProtection can be specified as an object for PasswordProtection of a RelationshipTemplate. If set, only the Identities that know the password specified within the passwordProtection.password property of the RelationshipTemplate can access it. In addition, the optional property passwordProtection.passwordIsPin can be used to configure the UI of the App in case the password is a pin.

On Success

On Failure

  • The content is malformed.
  • expiresAt lies in the past.
  • In case of password protection of the RelationshipTemplate, a passwordProtection.password that does not consist of 4 to 16 digits was specified, but the value of passwordProtection.passwordIsPin was nevertheless set to true.

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: