IdentityMetadata is used to store arbitrary auxiliary metadata related to an Identity within the Connector. This use case retrieves the IdentityMetadata for a given reference or a given combination of reference and key if the IdentityMetadata is equipped with the additional key identifier. As there is at most one IdentityMetadata per reference and key combination, the return value of this use case is uniquely determined.

Parameters

  • reference is the address of the Identity about which the IdentityMetadata is to be retrieved.
  • Optionally, key is the additional identifier of the IdentityMetadata to be retrieved.

On Success

  • Returns the IdentityMetadata for the specified combination of reference and key.

On Failure

  • There is no stored IdentityMetadata for the specified combination of reference and key.

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: