Skip to content

Commit 0d5b3af

Browse files
author
Corentin Mors
authored
Add better documents relations + update doc (#282)
From user support requests here are some updates to our documentation.
1 parent 5194e51 commit 0d5b3af

File tree

8 files changed

+63
-23
lines changed

8 files changed

+63
-23
lines changed

documentation/pages/business/audit-logs.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { Callout } from 'nextra/components';
1+
import { TeamCredentialsBanner } from '../../src/banners';
22

33
# Audit logs
44

5-
<Callout emoji="💡">Needs team credentials to use this command.</Callout>
5+
<TeamCredentialsBanner />
66

77
The audit logs helps you trace and prevent security vulnerabilities for your organization.
88

@@ -152,7 +152,7 @@ Note that a new key named `date_time_iso` will be added to the logs.
152152

153153
You can turn on logging sensitive actions in the Policies section of Settings in the Admin Console. Read more about it in our [dedicated Help Center article](https://support.dashlane.com/hc/en-us/articles/4414606120210).
154154

155-
| Type | Event message |
155+
| Type | Event message |
156156
| ------------------------------------------ | ------------------------------------------------------------------------------------------ |
157157
| collect_sensitive_data_audit_logs_enabled | (user) turned on additional activity logs (unencrypted) |
158158
| collect_sensitive_data_audit_logs_disabled | (user) turned off additional activity logs (unencrypted) |

documentation/pages/business/dwi.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { Callout } from 'nextra/components';
1+
import { TeamCredentialsBanner } from '../../src/banners';
22

33
# Dark Web Insights Reports
44

5-
<Callout emoji="💡">Needs team credentials to use this command.</Callout>
5+
<TeamCredentialsBanner />
66

77
Dark Web Insights can identify vulnerabilities across all employees in an organization, even employees who don't have a Dashlane account yet.
88
It does this by monitoring the dark web for employee email addresses to find domain-wide breaches and by scanning the web for any compromised organization information.

documentation/pages/business/index.mdx

+22-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { Callout } from 'nextra/components';
2+
import { AdminBanner } from '../../src/banners';
23

34
# Get started with Business Commands
45

@@ -9,39 +10,51 @@ The first step is to login with the personal account ([follow this guide](../per
910

1011
## Generate credentials
1112

12-
<Callout>Needs to be authenticated as an admin to use this command.</Callout>
13+
<AdminBanner />
1314

1415
```sh copy
1516
dcli t credentials generate
1617
```
1718

18-
You will be prompted with a list of variables to export in your environment. Simply copy/paste them in your terminal.
19+
You will be prompted with a variable to export in your environment. Simply copy/paste it in your terminal.
1920

2021
```sh copy
2122
export DASHLANE_TEAM_DEVICE_KEYS=dlt_[deviceAccessKey]_[payload]
2223
```
2324

24-
On Windows, you can use the `set` command instead of `export`.
25+
---
2526

26-
```sh copy
27-
set DASHLANE_TEAM_DEVICE_KEYS=dlt_[deviceAccessKey]_[payload]
27+
On **Windows**, you can use the following command instead of `export`.
28+
29+
```powershell copy
30+
$env:DASHLANE_TEAM_DEVICE_KEYS='dlt_[deviceAccessKey]_[payload]'
31+
```
32+
33+
You can ensure that the variable is correctly set by running:
34+
35+
```powershell copy
36+
Get-ChildItem Env:
2837
```
2938

30-
Make sure you save them in a safe place (use a secure note for instance 😉).
39+
---
40+
41+
Make sure you save the generated secret in a safe place (use a secure note for instance 😉).
3142

32-
<Callout type="info">The token you'll get is starting by `dlt` in order to be easily identified by scanning tools.</Callout>
43+
<Callout type="info">
44+
The token you'll get is starting by `dlt` in order to be easily identified by scanning tools.
45+
</Callout>
3346

3447
## List credentials
3548

36-
<Callout>Needs to be authenticated as an admin to use this command.</Callout>
49+
<AdminBanner />
3750

3851
```sh copy
3952
dcli t credentials list
4053
```
4154

4255
## Revoke credentials
4356

44-
<Callout>Needs to be authenticated as an admin to use this command.</Callout>
57+
<AdminBanner />
4558

4659
```sh copy
4760
dcli t credentials revoke <DASHLANE_TEAM_ACCESS_KEY>

documentation/pages/business/members.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { Callout } from 'nextra/components';
1+
import { TeamCredentialsBanner } from '../../src/banners';
22

33
# Listing members
44

5-
<Callout>Needs team credentials to use this command.</Callout>
5+
<TeamCredentialsBanner />
66

77
## Fetching the list of members
88

documentation/pages/business/reports.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
import { Callout } from 'nextra/components';
1+
import { TeamCredentialsBanner } from '../../src/banners';
22

33
# Reports
44

5-
<Callout emoji="💡">Needs team credentials to use this command.</Callout>
5+
<TeamCredentialsBanner />
66

77
You can get reports on your team containing:
88

documentation/pages/personal/devices.mdx

+16-3
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,25 @@ Run the suggested commands on your target device (your server or CI) to set the
6868
export DASHLANE_SERVICE_DEVICE_KEYS=dls_[deviceAccessKey]_[payload]
6969
```
7070

71-
On Windows, you can use the `set` command instead of `export`.
71+
---
7272

73-
```sh
74-
set DASHLANE_SERVICE_DEVICE_KEYS=dls_[deviceAccessKey]_[payload]
73+
On **Windows**, you can use the following command instead of `export`.
74+
75+
```powershell copy
76+
$env:DASHLANE_SERVICE_DEVICE_KEYS='dls_[deviceAccessKey]_[payload]'
7577
```
7678

79+
You can ensure that the variable is correctly set by running:
80+
81+
```powershell copy
82+
Get-ChildItem Env:
83+
```
84+
85+
---
86+
87+
Make sure to **save the generated secret in a safe place** (like a secure note).
88+
Consider it as **highly sensitive information** as it grants access to your vault.
89+
7790
<Callout type="info">
7891
The token you'll get is starting by `dls` in order to be easily identified by scanning tools.
7992
</Callout>

documentation/src/banners.jsx

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { Callout } from 'nextra/components';
2+
import Link from 'next/link';
3+
4+
export const TeamCredentialsBanner = () => {
5+
return (
6+
<Callout emoji="💡">This command needs team credentials to be used. See <Link href='/business' style={{ textDecoration: 'underline' }}>team credentials generation</Link>.</Callout>
7+
);
8+
};
9+
10+
export const AdminBanner = () => {
11+
return (
12+
<Callout emoji="🔒">This command is only available to team administrators.</Callout>
13+
);
14+
};

src/endpoints/getAuditLogs.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import { GenericLog } from '../types/logs.js';
55

66
export interface StartAuditLogsQueryParams {
77
/**
8-
* The start of the date range to query audit logs by. The format is unix timestamp in seconds. Only the date is used, not the time.
8+
* The start of the date range to query audit logs by. The format is unix timestamp in milliseconds. Only the date is used, not the time.
99
*/
1010
startDateRangeUnixMs: number;
1111
/**
12-
* The end of the date range of to query audit logs by. The format is unix timestamp in seconds. Only the date is used, not the time.
12+
* The end of the date range of to query audit logs by. The format is unix timestamp in milliseconds. Only the date is used, not the time.
1313
*/
1414
endDateRangeUnixMs: number;
1515
}

0 commit comments

Comments
 (0)