mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-01 19:17:58 +00:00
Activity Export API doc updates (#28172)
* remove export from restricted endpoints * enhance activity export JSON examples * fix nulls * add missing local_entity_alias fields * add JSON and CSV response examples * Simplify namespace filtering concept Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com> --------- Co-authored-by: Violet Hynes <violet.hynes@hashicorp.com>
This commit is contained in:
Chris Capurso
@@ -1088,8 +1088,11 @@ months in the requested time range.
|
||||
information returned by this API will include activity for this month, however
|
||||
it may be up to 20 minutes delayed.
|
||||
|
||||
- This endpoint can be called from all namespaces. The requested namespace will act as a filter. The exported data will include activity for the requested
|
||||
namespace and all of its children.
|
||||
|
||||
@include 'alerts/restricted-root.mdx'
|
||||
- **`sudo` required** – This endpoint requires `sudo` capability in addition to
|
||||
any path-specific capabilities.
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :---------------------------------------- |
|
||||
@@ -1118,11 +1121,129 @@ $ curl \
|
||||
http://127.0.0.1:8200/v1/sys/internal/counters/activity/export
|
||||
```
|
||||
|
||||
### Sample response
|
||||
### Sample JSON response
|
||||
|
||||
~> **NOTE**: The activity records below are pretty-printed to improve readability. The API returns
|
||||
JSON lines and will thus be compacted so that each record consumes a single line.
|
||||
|
||||
```json
|
||||
{"client_id":"3f210722-7210-98e8-1f0d-e6a39ffb29c6","namespace_id":"root","timestamp":1653350457,"mount_accessor":"auth_userpass_bb52979d"}
|
||||
{"client_id":"X/Yed4Oj4cqODj9tSHjKwnRy5QVSBRlX3COxjjWSXyI=","namespace_id":"root","timestamp":1653350491,"non_entity":true,"mount_accessor":"auth_token_f6f2c11c"}
|
||||
{"client_id":"d93405dc-b592-b1c3-a520-14e618d359c1","namespace_id":"root","timestamp":1653350501,"mount_accessor":"auth_userpass_bb52979d"}
|
||||
{
|
||||
"entity_name": "admin",
|
||||
"entity_alias_name": "admin",
|
||||
"local_entity_alias": false,
|
||||
"client_id": "3f210722-7210-98e8-1f0d-e6a39ffb29c6",
|
||||
"client_type": "entity",
|
||||
"namespace_id": "root",
|
||||
"namespace_path": "",
|
||||
"mount_accessor": "auth_userpass_a005db73",
|
||||
"mount_type": "userpass",
|
||||
"mount_path": "auth/userpass/",
|
||||
"timestamp": "2024-07-10T09:33:51Z",
|
||||
"policies": [
|
||||
"secret-read",
|
||||
"secret-list",
|
||||
"secret-write",
|
||||
"secret-delete"
|
||||
],
|
||||
"entity_metadata": {
|
||||
"email_address": "admin@example.com"
|
||||
},
|
||||
"entity_alias_metadata": {},
|
||||
"entity_alias_custom_metadata": {
|
||||
"region": "west",
|
||||
"group": "san_francisco",
|
||||
"contact_email": "admin@example.com"
|
||||
},
|
||||
"entity_group_ids": [
|
||||
"746fbaf9-ffeb-62b9-7f0b-42d79ca0883f"
|
||||
]
|
||||
}
|
||||
|
||||
{
|
||||
"entity_name": "",
|
||||
"entity_alias_name": "",
|
||||
"local_entity_alias": false,
|
||||
"client_id": "590198f7-9178-57d6-c345-48746bb438d8",
|
||||
"client_type": "non-entity-token",
|
||||
"namespace_id": "YWZzu",
|
||||
"namespace_path": "ns1/a/",
|
||||
"mount_accessor": "auth_ns_token_e3119312",
|
||||
"mount_type": "ns_token",
|
||||
"mount_path": "auth/token/",
|
||||
"timestamp": "2024-07-08T11:35:23Z",
|
||||
"policies": [],
|
||||
"entity_metadata": {},
|
||||
"entity_alias_metadata": {},
|
||||
"entity_alias_custom_metadata": {},
|
||||
"entity_group_ids": []
|
||||
}
|
||||
|
||||
{
|
||||
"entity_name": "jdoe",
|
||||
"entity_alias_name": "jdoe",
|
||||
"local_entity_alias": false,
|
||||
"client_id": "665a54bf-8652-c0c5-8121-40adf0d9786a",
|
||||
"client_type": "entity",
|
||||
"namespace_id": "wOsmr",
|
||||
"namespace_path": "ns1/a",
|
||||
"mount_accessor": "auth_ldap_a005db73",
|
||||
"mount_type": "ldap",
|
||||
"mount_path": "auth/ldap/",
|
||||
"timestamp": "2024-07-08T11:47:57Z",
|
||||
"policies": [
|
||||
"secret-read"
|
||||
],
|
||||
"entity_metadata": {},
|
||||
"entity_alias_metadata": {},
|
||||
"entity_alias_custom_metadata": {
|
||||
"contact_email": "jdoe@example.com",
|
||||
"region": "east",
|
||||
"group": "new_york"
|
||||
},
|
||||
"entity_group_ids": [
|
||||
"9f18cd4a-4e64-a2b2-b001-7b6b0dfb1270"
|
||||
]
|
||||
}
|
||||
|
||||
{
|
||||
"entity_name": "jdoe",
|
||||
"entity_alias_name": "jdoe",
|
||||
"local_entity_alias": false,
|
||||
"client_id": "0640a8f0-b315-cc8a-c0c2-713f663774df",
|
||||
"client_type": "entity",
|
||||
"namespace_id": "oIiGy",
|
||||
"namespace_path": "ns1/b",
|
||||
"mount_accessor": "auth_userpass_01a6ea85",
|
||||
"mount_type": "userpass",
|
||||
"mount_path": "auth/userpass/",
|
||||
"timestamp": "2024-07-21T14:51:36Z",
|
||||
"policies": [
|
||||
"secret-read"
|
||||
],
|
||||
"entity_metadata": {},
|
||||
"entity_alias_metadata": {},
|
||||
"entity_alias_custom_metadata": {
|
||||
"region": "east",
|
||||
"group": "new_york"
|
||||
},
|
||||
"entity_group_ids": [
|
||||
"76a374a1-72fd-30ca-2455-f51dfeaa805e"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Sample CSV response
|
||||
Nested fields within the exported records will be flattened into individual CSV columns. Columns for arrays (`policies` and `entity_group_ids`)
|
||||
will be named using the field name and underlying index (e.g. `policies.0`, `policies.1`). Columns for key-value pairs
|
||||
(`entity_metadata`, `entity_alias_metadata`, and `entity_alias_custom_metadata`) will be named using the field name and underlying key
|
||||
(e.g. `entity_metadata.email_address`, `entity_alias_metadata.region`). A flattened field will only be added if at least one record contains
|
||||
it. If a top-level field (e.g. `entity_metadata`) is not populated in any of the records then there will not be any flattened fields of prefix `enttiy_metadata.`.
|
||||
|
||||
```text
|
||||
entity_name,entity_alias_name,client_id,client_type,local_entity_alias,namespace_id,namespace_path,mount_accessor,mount_path,mount_type,timestamp,entity_alias_custom_metadata.contact_email,entity_alias_custom_metadata.group,entity_alias_custom_metadata.region,entity_metadata.email_address,entity_group_ids.0,policies.0,policies.1,policies.2,policies.4
|
||||
admin,admin,3f210722-7210-98e8-1f0d-e6a39ffb29c6,entity,false,root,,auth_userpass_a005db73,auth/userpass/,userpass,2024-07-10T09:33:51Z,admin@example.com,san_francisco,west,admin@example.com,746fbaf9-ffeb-62b9-7f0b-42d79ca0883f,secret-read,secret-list,secret-write,secret-delete
|
||||
,,590198f7-9178-57d6-c345-48746bb438d8,non-entity-token,false,YWZzu,ns1/a/,auth_ns_token_e3119312,auth/token/,ns_token,2024-07-08T11:35:23Z,,,,,,,,,
|
||||
jdoe,jdoe,665a54bf-8652-c0c5-8121-40adf0d9786a,entity,false,wOsmr,ns1/a,auth_ldap_a005db73,auth/ldap/,ldap,2024-07-08T11:47:57Z,jdoe@example.com,new_york,east,,9f18cd4a-4e64-a2b2-b001-7b6b0dfb1270,secret-read,,,
|
||||
jdoe,jdoe,0640a8f0-b315-cc8a-c0c2-713f663774df,entity,false,oIiGy,ns1/b,auth_userpass_01a6ea85,auth/userpass/,userpass,2024-07-21T14:51:36Z,,new_york,east,,76a374a1-72fd-30ca-2455-f51dfeaa805e,secret-read,,,
|
||||
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user