Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

VAULT-6818 Docs for entity merge functionality #16593

Merged
merged 2 commits into from
Aug 10, 2022
Merged

VAULT-6818 Docs for entity merge functionality #16593

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd54546
VAULT-6818 Docs for entity merge functionality
VioletHynes Aug 4, 2022
e63656c
VAULT-6818 Elaborate more on what happens to non-kept aliases
VioletHynes Aug 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion website/content/api-docs/secret/identity/entity.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,14 +396,17 @@ $ curl \
## Merge Entities

This endpoint merges many entities into one entity. Additionally, all groups associated with `from_entity_ids` are merged with those of `to_entity_id`.
Note that if these entities contain aliases sharing the same mount accessor, the merge will fail unless `conflicting_alias_ids_to_keep` is present, and
entities must be merged one at a time. This is because each entity can only have one alias with each mount accessor - for more
information, see the [identity concepts page](/docs/concepts/identity).

| Method | Path |
| :----- | :----------------------- |
| `POST` | `/identity/entity/merge` |

### Parameters

- `from_entity_ids` `(array: <required>)` - Entity IDs which needs to get
- `from_entity_ids` `(list of strings: <required>)` - Entity IDs which need to get
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was updated as it was the only list of strings on the page to use "array" in lieu of "list of strings". In other words, this change keeps the language consistent throughout the page.

merged.

- `to_entity_id` `(string: <required>)` - Entity ID into which all the other
Expand All @@ -415,6 +418,12 @@ This endpoint merges many entities into one entity. Additionally, all groups ass
secrets in the destination will be unaltered. If not set, this API will throw
an error containing all the conflicts.

- `conflicting_alias_ids_to_keep` `(list of strings: [])` - A list of entity
aliases to keep in the case where the to-Entity and from-Entity have aliases
with the same mount accessor. In the case where alias share mount accessors,
the alias ID given in this list will be kept or merged, and the other alias will be deleted.
Note that merges requiring this parameter must have only one from-Entity.

### Sample Payload

```json
Expand Down