Skip to content

Commit

Permalink
feat: add delete IdentityMetadata use case
Browse files Browse the repository at this point in the history
  • Loading branch information
britsta committed Dec 20, 2024
1 parent 418ee10 commit 07f136f
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions _docs_use-cases/use-case-consumption-delete-identitymetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,26 @@ required_by:
api_route_regex: ^DELETE /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 deletes 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 IdentityMetadata that can be deleted by this use case is uniquely determined.

## Parameters

- `reference` is the `address` of the Identity about which the IdentityMetadata is to be deleted.
- `key` is the optional additional identifier of the IdentityMetadata to be deleted.

## On Success

- Deletes the IdentityMetadata for the specified combination of `reference` and `key`.

## On Failure

- The parameters are malformed.

<!-- TODO: Should a validation be added for case "There is no stored IdentityMetadata for the specified combination of `reference` and `key`."? -->

0 comments on commit 07f136f

Please sign in to comment.