Skip to content

Commit

Permalink
feat: add get IdentityMetadata use case
Browse files Browse the repository at this point in the history
  • Loading branch information
britsta committed Dec 20, 2024
1 parent 130c035 commit 418ee10
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions _docs_use-cases/use-case-consumption-get-identitymetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,24 @@ required_by:
api_route_regex: ^GET /api/v2/IdentityMetadata$
# End automatic generation
---

{{properties.description}}

{% include properties_list.html %}

[IdentityMetadata]({% link _docs_integrate/data-model-overview.md %}#identitymetadata) is used to store arbitrary auxiliary metadata related to an [Identity]({% link _docs_integrate/data-model-overview.md %}#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 optional 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.
- `key` is the optional 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`.
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ by its `id`.

## Parameters

- `id`of the RelationshipTemplate.
- `id` of the RelationshipTemplate.

## On Success

Expand Down

0 comments on commit 418ee10

Please sign in to comment.