Integrate enmeshed

Creates a Token for a given File that corresponds to the given fileId.

Parameters

  • fileId is the id of the File the Token should be created for.
  • Optionally, expiresAt can be specified, which describes the ISODateTime the Token expires at.
  • Optionally, ephemeral can be specified, which indicates if the Token should be ephemeral and thus not be stored and cached on the local database. This is especially useful for Tokens which are created regularly, e.g. for RelationshipTemplates and don’t need to be stored.
  • Optionally, forIdentity can be specified, which names the address of the only Identity that will be able to load the Token from the Backbone.
  • Optionally, passwordProtection can be specified as an object for PasswordProtection of a Token. If set, only the Identities that know the password specified within the passwordProtection.password property of the Token can load it from the Backbone. 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

  • Returns the created Token.

On Failure

  • fileId does not resolve to a File.
  • expiresAt lies in the past.
  • In case of password protection of the Token, 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: