mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2025-08-17 12:07:02 +02:00
Code Issues Projects Releases Wiki Activity

update entity-alias doc fix (#19435)

Browse Source
This commit is contained in:
Max Winslow 2023-03-03 09:16:26 -07:00 committed by GitHub
parent d2a09ad453
commit c5d99edfec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
website/content/api-docs/secret/identity/entity-alias.mdx
View File

@ -135,14 +135,14 @@ This endpoint is used to update an existing entity alias.
- `id` `(string: <required>)` – Identifier of the entity alias. - `id` `(string: <required>)` – Identifier of the entity alias.
- `name` `(string: <required>)` - Name of the alias. Name should be the identifier - `name` `(string: "")` - Name of the alias. Name should be the identifier
of the client in the authentication source. For example, if the alias belongs of the client in the authentication source. For example, if the alias belongs
to userpass backend, the name should be a valid username within userpass to userpass backend, the name should be a valid username within userpass
backend. If alias belongs to GitHub, it should be the GitHub username. backend. If alias belongs to GitHub, it should be the GitHub username.
- `canonical_id` `(string: <required>)` - Entity ID to which this alias belongs to. - `canonical_id` `(string: "")` - Entity ID to which this alias belongs to.
- `mount_accessor` `(string: <required>)` - Accessor of the mount to which the - `mount_accessor` `(string: "")` - Accessor of the mount to which the
alias should belong to. alias should belong to.
- `custom_metadata` `(map<string|string>: <optional>)` - A map of arbitrary string to string valued - `custom_metadata` `(map<string|string>: <optional>)` - A map of arbitrary string to string valued