diff --git a/documentation/pages/business/audit-logs.mdx b/documentation/pages/business/audit-logs.mdx index d2ed936..e876166 100644 --- a/documentation/pages/business/audit-logs.mdx +++ b/documentation/pages/business/audit-logs.mdx @@ -1,8 +1,8 @@ -import { Callout } from 'nextra/components'; +import { TeamCredentialsBanner } from '../../src/banners'; # Audit logs -Needs team credentials to use this command. + The audit logs helps you trace and prevent security vulnerabilities for your organization. @@ -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) | diff --git a/documentation/pages/business/dwi.mdx b/documentation/pages/business/dwi.mdx index 5b5de38..4a836c7 100644 --- a/documentation/pages/business/dwi.mdx +++ b/documentation/pages/business/dwi.mdx @@ -1,8 +1,8 @@ -import { Callout } from 'nextra/components'; +import { TeamCredentialsBanner } from '../../src/banners'; # Dark Web Insights Reports -Needs team credentials to use this command. + 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. diff --git a/documentation/pages/business/index.mdx b/documentation/pages/business/index.mdx index 5b2b942..036083b 100644 --- a/documentation/pages/business/index.mdx +++ b/documentation/pages/business/index.mdx @@ -1,4 +1,5 @@ import { Callout } from 'nextra/components'; +import { AdminBanner } from '../../src/banners'; # Get started with Business Commands @@ -9,31 +10,43 @@ The first step is to login with the personal account ([follow this guide](../per ## Generate credentials -Needs to be authenticated as an admin to use this command. + ```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 😉). -The token you'll get is starting by `dlt` in order to be easily identified by scanning tools. + + The token you'll get is starting by `dlt` in order to be easily identified by scanning tools. + ## List credentials -Needs to be authenticated as an admin to use this command. + ```sh copy dcli t credentials list @@ -41,7 +54,7 @@ dcli t credentials list ## Revoke credentials -Needs to be authenticated as an admin to use this command. + ```sh copy dcli t credentials revoke diff --git a/documentation/pages/business/members.mdx b/documentation/pages/business/members.mdx index 63acc78..22e411f 100644 --- a/documentation/pages/business/members.mdx +++ b/documentation/pages/business/members.mdx @@ -1,8 +1,8 @@ -import { Callout } from 'nextra/components'; +import { TeamCredentialsBanner } from '../../src/banners'; # Listing members -Needs team credentials to use this command. + ## Fetching the list of members diff --git a/documentation/pages/business/reports.mdx b/documentation/pages/business/reports.mdx index 091b0f5..4cc9601 100644 --- a/documentation/pages/business/reports.mdx +++ b/documentation/pages/business/reports.mdx @@ -1,8 +1,8 @@ -import { Callout } from 'nextra/components'; +import { TeamCredentialsBanner } from '../../src/banners'; # Reports -Needs team credentials to use this command. + You can get reports on your team containing: diff --git a/documentation/pages/personal/devices.mdx b/documentation/pages/personal/devices.mdx index 2272944..26c0f5d 100644 --- a/documentation/pages/personal/devices.mdx +++ b/documentation/pages/personal/devices.mdx @@ -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. + The token you'll get is starting by `dls` in order to be easily identified by scanning tools. diff --git a/documentation/src/banners.jsx b/documentation/src/banners.jsx new file mode 100644 index 0000000..ec77bf2 --- /dev/null +++ b/documentation/src/banners.jsx @@ -0,0 +1,14 @@ +import { Callout } from 'nextra/components'; +import Link from 'next/link'; + +export const TeamCredentialsBanner = () => { + return ( + This command needs team credentials to be used. See team credentials generation. + ); +}; + +export const AdminBanner = () => { + return ( + This command is only available to team administrators. + ); +}; \ No newline at end of file diff --git a/src/endpoints/getAuditLogs.ts b/src/endpoints/getAuditLogs.ts index 5c96c97..0571a88 100644 --- a/src/endpoints/getAuditLogs.ts +++ b/src/endpoints/getAuditLogs.ts @@ -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; }