Skip to content

Commit

Permalink
feat: add forIdentity and passwordProtection to getters of Relationsh…
Browse files Browse the repository at this point in the history
…ipTemplates and Tokens
  • Loading branch information
britsta committed Dec 19, 2024
1 parent bfb6c50 commit 363e930
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ api_route_regex: ^GET /api/v2/RelationshipTemplates$

{% include properties_list.html %}

This use case queries [RelationshipTemplates]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate)
of the Identity.
This use case queries [RelationshipTemplates]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) of the Identity.

## Parameters

Expand All @@ -56,7 +55,9 @@ All parameters are optional. If no parameter is given, all RelationshipTemplates
- `expiresAt` is the ISODateTime the RelationshipTemplate expires.
- `createdBy` is the enmeshed `address` of the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) that created the RelationshipTemplate.
- `createdByDevice` is the `id` of the Device that created the RelationshipTemplate.
- `maxNumberOfAllocations` is the number of times the RelationshipTemplate can be accessed by different Identities to initiate a Relationship. The Backbone returns an error, if one accesses a RelationshipTemplate with no allocations left. Accessing the same RelationshipTemplate with the same Identity multiple times doesn't affect the number of allocations. The allocation counts, even if the Identity does not accept the RelationshipTemplate by discarding it.
- `maxNumberOfAllocations` is the number of times the RelationshipTemplate can be accessed by different Identities to initiate a Relationship. The Backbone returns an error if one accesses a RelationshipTemplate with no allocations left. Accessing the same RelationshipTemplate with the same Identity multiple times doesn't affect the number of allocations. The allocation counts, even if the Identity does not accept the RelationshipTemplate by discarding it.
- `forIdentity` is the enmeshed `address` of the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) for which the RelationshipTemplate is intended.
- `passwordProtection` is an [object for password protection of a RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#object-for-password-protection-of-relationshiptemplate).

## On Success

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ This use case queries [Tokens]({% link _docs_integrate/data-model-overview.md %}
- `createdBy` is the enmeshed `address` of the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) that created the Token.
- `createdByDevice` is the `id` of the Device that created the Token.
- `expiresAt` is the ISODateTime the Token expires.
- `forIdentity` is the enmeshed `address` of the [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) for which the Token is intended.
- `passwordProtection` is an [object for password protection of a Token]({% link _docs_integrate/data-model-overview.md %}#object-for-password-protection-of-token).

## On Success

Expand Down

0 comments on commit 363e930

Please sign in to comment.