48 lines
1.4 KiB
Org Mode
48 lines
1.4 KiB
Org Mode
|
:PROPERTIES:
|
||
|
|
:ID: b129bbc2-43c7-4ba6-bcba-23fcc45add4f
|
||
|
|
:END:
|
||
|
|
#+Title: Cisco IROH Client Data Retention
|
||
|
|
#+Author: Yann Esposito
|
||
|
|
#+Date: [2024-06-05]
|
||
|
|
|
||
|
|
- tags ::
|
||
|
|
- source ::
|
||
|
|
|
||
|
|
* Recommendation
|
||
|
|
|
||
|
|
As a client of XDR API (IROH) you can retrieve the Data Retention policy using
|
||
|
|
multiple APIs. But the recommended API to use is ~/iroh/profile/whoami~
|
||
|
|
(See link in TEST: https://visibility.test.iroh.site/iroh/profile/index.html#/Profile/get_iroh_profile_whoami)
|
||
|
|
|
||
|
|
You should call this API using an IROH access token that you could retrieve
|
||
|
|
using the refresh token you should already have for your customer.
|
||
|
|
|
||
|
|
Inside this HTTP call, the body of the request should looks like:
|
||
|
|
|
||
|
|
#+begin_src javascript
|
||
|
|
{
|
||
|
|
"user": {...},
|
||
|
|
"org": {
|
||
|
|
...
|
||
|
|
"entitlement-summary": {
|
||
|
|
"tier": {"title": "advantage", ...},
|
||
|
|
"extra_data_retention": {...},
|
||
|
|
"extra_ingest": {...},
|
||
|
|
"techvals": {
|
||
|
|
"data-retention-in-days": 180,
|
||
|
|
"data-maximal-size-in-GB": 30,
|
||
|
|
...
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
#+end_src
|
||
|
|
|
||
|
|
The recommended method to retrieve the number of days is to use
|
||
|
|
~org["entitlement-summary"]["techvals"]["data-retention-in-days"]~ value.
|
||
|
|
Note for some org the entitlement summary will not be provided entirely as some
|
||
|
|
XDR org do not have any entitlements (beta orgs, test orgs, not yet sync with
|
||
|
|
PIAM, etc…)
|
||
|
|
|
||
|
|
For these cases we do not provide any default number of day.
|