Docs/custom metadata updates (#13244)

* adding custom_metadata read and update changes * adding custom metadata changes
hashicorp · Nov 23, 2021 · 7800c45 · 7800c45
1 parent 5522aab
commit 7800c45
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 14 deletions.
diff --git a/website/content/api-docs/secret/identity/entity-alias.mdx b/website/content/api-docs/secret/identity/entity-alias.mdx
@@ -40,13 +40,19 @@ This endpoint creates a new alias for an entity.
 - `mount_accessor` `(string: <required>)` - Accessor of the mount to which the
   alias should belong to.
 
+- `custom_metadata` `(map<string|string>: <optional>)` - A map of arbitrary string to string valued 
+  user-provided metadata meant to describe the alias.
+
 ### Sample Payload
 
 ```json
 {
   "name": "testuser",
   "canonical_id": "404e57bc-a0b1-a80f-0a73-b6e92e8a52d3",
-  "mount_accessor": "auth_userpass_e50b1a44"
+  "mount_accessor": "auth_userpass_e50b1a44",
+  "custom_metadata": {
+    "contact_email": "james_updated@example.com"
+  }
 }
 ```
 
@@ -138,13 +144,19 @@ This endpoint is used to update an existing entity alias.
 - `mount_accessor` `(string: <required>)` - Accessor of the mount to which the
   alias should belong to.
 
+- `custom_metadata` `(map<string|string>: <optional>)` - A map of arbitrary string to string valued 
+  user-provided metadata meant to describe the alias.
+
 ### Sample Payload
 
 ```json
 {
   "name": "testuser",
   "canonical_id": "404e57bc-a0b1-a80f-0a73-b6e92e8a52d3",
   "mount_accessor": "auth_userpass_e50b1a44"
+   "custom_metadata": {
+    "contact_email": "james@example.com"
+  }
 }
 ```
 

diff --git a/website/content/docs/concepts/policies.mdx b/website/content/docs/concepts/policies.mdx
@@ -256,18 +256,19 @@ injected, and currently the `path` keys in policies allow injection.
 
 ### Parameters
 
-| Name                                                               | Description                                                             |
-| :----------------------------------------------------------------- | :---------------------------------------------------------------------- |
-| `identity.entity.id`                                               | The entity's ID                                                         |
-| `identity.entity.name`                                             | The entity's name                                                       |
-| `identity.entity.metadata.<metadata key>`                          | Metadata associated with the entity for the given key                   |
-| `identity.entity.aliases.<mount accessor>.id`                      | Entity alias ID for the given mount                                     |
-| `identity.entity.aliases.<mount accessor>.name`                    | Entity alias name for the given mount                                   |
-| `identity.entity.aliases.<mount accessor>.metadata.<metadata key>` | Metadata associated with the alias for the given mount and metadata key |
-| `identity.groups.ids.<group id>.name`                              | The group name for the given group ID                                   |
-| `identity.groups.names.<group name>.id`                            | The group ID for the given group name                                   |
-| `identity.groups.ids.<group id>.metadata.<metadata key>`           | Metadata associated with the group for the given key                    |
-| `identity.groups.names.<group name>.metadata.<metadata key>`       | Metadata associated with the group for the given key                    |
+| Name                                                                             | Description                                                                            |
+| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- |
+| `identity.entity.id`                                                             | The entity's ID                                                                        |
+| `identity.entity.name`                                                           | The entity's name                                                                      |
+| `identity.entity.metadata.<metadata key>`                                        | Metadata associated with the entity for the given key                                  |
+| `identity.entity.aliases.<mount accessor>.id`                                    | Entity alias ID for the given mount                                                    |
+| `identity.entity.aliases.<mount accessor>.name`                                  | Entity alias name for the given mount                                                  |
+| `identity.entity.aliases.<mount accessor>.metadata.<metadata key>`               | Metadata associated with the alias for the given mount and metadata key                |
+| `identity.entity.aliases.<mount accessor>.custom_metadata.<custom_metadata key>` | Custom metadata associated with the alias for the given mount and custom metadata key  |
+| `identity.groups.ids.<group id>.name`                                            | The group name for the given group ID                                                  |
+| `identity.groups.names.<group name>.id`                                          | The group ID for the given group name                                                  |
+| `identity.groups.ids.<group id>.metadata.<metadata key>`                         | Metadata associated with the group for the given key                                   |
+| `identity.groups.names.<group name>.metadata.<metadata key>`                     | Metadata associated with the group for the given key                                   |
 
 ### Examples
 

diff --git a/website/content/docs/enterprise/sentinel/properties.mdx b/website/content/docs/enterprise/sentinel/properties.mdx
@@ -115,7 +115,8 @@ These can be retrieved from `identity.entity.aliases`.
 | `creation_time`          | `string`                 | The alias's creation time in RFC3339 format                                                                                                   |
 | `id`                     | `string`                 | The alias's ID                                                                                                                                |
 | `last_update_time`       | `string`                 | The alias's last update (modify) time in RFC3339 format                                                                                       |
-| `metadata`               | `map (string -> string)` | Metadata associated with the alias                                                                                                            |
+| `metadata`               | `map (string -> string)` | Metadata associated with the alias
+| `custom_metadata`        | `map (string -> string)` | Custom metadata associated with the alias                                                                                                            |
 | `merged_from_entity_ids` | `list (string)`          | If this alias was attached to the current entity via one or more merges, the original entity/entities will be in this list                    |
 | `mount_accessor`         | `string`                 | The immutable accessor of the mount that created this alias                                                                                   |
 | `mount_path`             | `string`                 | The path of the mount that created this alias; unlike the accessor, there is no guarantee that the current path represents the original mount |