Get IdentityMetadata
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 theaddress
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
andkey
.
On Failure
- There is no stored IdentityMetadata for the specified combination of
reference
andkey
.