Skip to content

Commit

Permalink
Add better documents relations + update doc (#282)
Browse files Browse the repository at this point in the history
From user support requests here are some updates to our documentation.
  • Loading branch information
Mikescops authored Sep 5, 2024
1 parent 5194e51 commit 0d5b3af
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 23 deletions.
6 changes: 3 additions & 3 deletions documentation/pages/business/audit-logs.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Callout } from 'nextra/components';
import { TeamCredentialsBanner } from '../../src/banners';

# Audit logs

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

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

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

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).

| Type | Event message |
| Type | Event message |
| ------------------------------------------ | ------------------------------------------------------------------------------------------ |
| collect_sensitive_data_audit_logs_enabled | (user) turned on additional activity logs (unencrypted) |
| collect_sensitive_data_audit_logs_disabled | (user) turned off additional activity logs (unencrypted) |
Expand Down
4 changes: 2 additions & 2 deletions documentation/pages/business/dwi.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Callout } from 'nextra/components';
import { TeamCredentialsBanner } from '../../src/banners';

# Dark Web Insights Reports

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

Dark Web Insights can identify vulnerabilities across all employees in an organization, even employees who don't have a Dashlane account yet.
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.
Expand Down
31 changes: 22 additions & 9 deletions documentation/pages/business/index.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Callout } from 'nextra/components';
import { AdminBanner } from '../../src/banners';

# Get started with Business Commands

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

## Generate credentials

<Callout>Needs to be authenticated as an admin to use this command.</Callout>
<AdminBanner />

```sh copy
dcli t credentials generate
```

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

```sh copy
export DASHLANE_TEAM_DEVICE_KEYS=dlt_[deviceAccessKey]_[payload]
```

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

```sh copy
set DASHLANE_TEAM_DEVICE_KEYS=dlt_[deviceAccessKey]_[payload]
On **Windows**, you can use the following command instead of `export`.

```powershell copy
$env:DASHLANE_TEAM_DEVICE_KEYS='dlt_[deviceAccessKey]_[payload]'
```

You can ensure that the variable is correctly set by running:

```powershell copy
Get-ChildItem Env:
```

Make sure you save them in a safe place (use a secure note for instance 😉).
---

Make sure you save the generated secret in a safe place (use a secure note for instance 😉).

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

## List credentials

<Callout>Needs to be authenticated as an admin to use this command.</Callout>
<AdminBanner />

```sh copy
dcli t credentials list
```

## Revoke credentials

<Callout>Needs to be authenticated as an admin to use this command.</Callout>
<AdminBanner />

```sh copy
dcli t credentials revoke <DASHLANE_TEAM_ACCESS_KEY>
Expand Down
4 changes: 2 additions & 2 deletions documentation/pages/business/members.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Callout } from 'nextra/components';
import { TeamCredentialsBanner } from '../../src/banners';

# Listing members

<Callout>Needs team credentials to use this command.</Callout>
<TeamCredentialsBanner />

## Fetching the list of members

Expand Down
4 changes: 2 additions & 2 deletions documentation/pages/business/reports.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Callout } from 'nextra/components';
import { TeamCredentialsBanner } from '../../src/banners';

# Reports

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

You can get reports on your team containing:

Expand Down
19 changes: 16 additions & 3 deletions documentation/pages/personal/devices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,25 @@ Run the suggested commands on your target device (your server or CI) to set the
export DASHLANE_SERVICE_DEVICE_KEYS=dls_[deviceAccessKey]_[payload]
```

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

```sh
set DASHLANE_SERVICE_DEVICE_KEYS=dls_[deviceAccessKey]_[payload]
On **Windows**, you can use the following command instead of `export`.

```powershell copy
$env:DASHLANE_SERVICE_DEVICE_KEYS='dls_[deviceAccessKey]_[payload]'
```

You can ensure that the variable is correctly set by running:

```powershell copy
Get-ChildItem Env:
```

---

Make sure to **save the generated secret in a safe place** (like a secure note).
Consider it as **highly sensitive information** as it grants access to your vault.

<Callout type="info">
The token you'll get is starting by `dls` in order to be easily identified by scanning tools.
</Callout>
Expand Down
14 changes: 14 additions & 0 deletions documentation/src/banners.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { Callout } from 'nextra/components';
import Link from 'next/link';

export const TeamCredentialsBanner = () => {
return (
<Callout emoji="💡">This command needs team credentials to be used. See <Link href='/business' style={{ textDecoration: 'underline' }}>team credentials generation</Link>.</Callout>
);
};

export const AdminBanner = () => {
return (
<Callout emoji="🔒">This command is only available to team administrators.</Callout>
);
};
4 changes: 2 additions & 2 deletions src/endpoints/getAuditLogs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import { GenericLog } from '../types/logs.js';

export interface StartAuditLogsQueryParams {
/**
* 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.
* 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.
*/
startDateRangeUnixMs: number;
/**
* 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.
* 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.
*/
endDateRangeUnixMs: number;
}
Expand Down

0 comments on commit 0d5b3af

Please sign in to comment.