Skip to content

Commit

Permalink
Authoring in progress
Browse files Browse the repository at this point in the history
  • Loading branch information
sujitnewrelic committed Jan 21, 2025
1 parent 5e2e16f commit fe0b3d3
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,113 @@ freshnessValidatedDate: never
When you share dashboards or charts publicly via live URLs, it exposes sensitive data to external viewers, so it's critical to manage access and permissions carefully. Ensure you have the following setups as per your requirement to securely share dashboards and charts.

Check notice on line 18 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L18

[new-relic.Adverbs] Consider removing 'carefully'.
Raw output
{"message": "[new-relic.Adverbs] Consider removing 'carefully'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 18, "column": 158}}}, "severity": "INFO"}

Check notice on line 18 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L18

[Microsoft.Wordiness] Consider using 'per' instead of 'as per'.
Raw output
{"message": "[Microsoft.Wordiness] Consider using 'per' instead of 'as per'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 18, "column": 206}}}, "severity": "INFO"}

Each of the following personas has specific responsibilities in this process:
* **Authentication domain manager**: Controls the feature's enablement organization-wide.
* **Authentication domain manager**: Controls the feature's enablement in account level.
* **Administrator**: Configures custom roles and permissions for users to manage live URLs.

## Feature enablement [#feature-enablement]
For sharing dashboards publicly, the Authentication domain manager needs to check and enable the <DNT>**Live Url Creation**</DNT> policy at the account level. This is not applicable to chart sharing. The Authentication domain manager can check the status of this policy in accounts, and enable or disable it only via NerdGraph API.

Check failure on line 25 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L25

[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Raw output
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 25, "column": 165}}}, "severity": "ERROR"}

<CollapserGroup>
<Collapser
id="check-policy-status"
title="Check status of the <DNT>**Live Url Creation**</DNT> policy in accounts"
>
As an Authentication Domain Manager, you can check the current status of the <DNT>**Live Url Creation**</DNT> policy in specific accounts. Use the [NerdGraph API explorer](https://one.newrelic.com/nerdgraph-graphiql) to construct a [graph API call](/docs/apis/nerdgraph/get-started/nerdgraph-explorer) as following. Replace `1, 2, 3` with actual account IDs. If you don't provide the account IDs, the call returns the status of your authorized account. You can query up to 100 accounts simultaneously.

Check notice on line 32 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L32

[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'give' or 'offer' instead of 'provide'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 32, "column": 377}}}, "severity": "INFO"}

```
{
actor {
dashboard {
liveUrlCreationPolicies(filter: {
accountIds: [1, 2, 3]
}) {
liveUrlCreationPolicies {
accountId
liveUrlCreationAllowed
}
}
}
}
}
```
A sample response appears as following:

```
{
{
"data": {
"actor": {
"dashboard": {
"liveUrlCreationPolicies": {
"liveUrlCreationPolicies": [
{
"accountId": 1,
"liveUrlCreationAllowed": true
},
{
"accountId": 2,
"liveUrlCreationAllowed": false
}
]
}
}
}
}
}
```
</Collapser>

<Collapser
id="enable-disable-policy"
title="Enable or disable the <DNT>**Live Url Creation**</DNT> policy in accounts"
>
As an Authentication Domain Manager, you can enable or disable the <DNT>**Live Url Creation**</DNT> policy in specific accounts. Ensure you have authorization for these accounts. Use the [NerdGraph API explorer](https://one.newrelic.com/nerdgraph-graphiql) to construct a [graph API call](/docs/apis/nerdgraph/get-started/nerdgraph-explorer) as given here with the following changes:
* Replace `1, 2, 3` with actual account IDs.
* Set `liveUrlCreationAllowed` to `true` to enable the policy, or `false` to disable it.

You can query up to 100 accounts simultaneously. Each successful update triggers an audit event for the corresponding account ID.

```
mutation {
dashboardUpdateLiveUrlCreationPolicies(
policiesInput: {
accountIds: [1,2],
liveUrlCreationAllowed: true}
) {
liveUrlCreationPolicies {
accountId
liveUrlCreationAllowed
}
}
}
```
A sample response appears as following. If you have provided an unknown account ID, the response will show `UNAUTHORIZED` error code.

```
{
"data": {
"dashboardUpdateLiveUrlCreationPolicies": {
"liveUrlCreationPolicies": [
{
"accountId": 1,
"liveUrlCreationAllowed": true
},
{
"accountId": 2,
"liveUrlCreationAllowed": true
}
]
}
}
}
```
</Collapser>

</CollapserGroup>


## Access management [#access-management]
Expand All @@ -34,10 +136,10 @@ As an Administrator perform the following steps to grant access to a user for [m
<Step>
### Add permissions to a custom role [#permissions-to-custom-role]

Check notice on line 137 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L137

[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
Raw output
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 137, "column": 9}}}, "severity": "INFO"}
[Create a new custom role](/docs/accounts/accounts-billing/new-relic-one-user-management/account-user-mgmt-tutorial/#roles) with the following permissions, or add them to an existing role. Check with the user to understand the level of access required.
* `Live Chart Url (all)`: Access details of live URLs for all users.
* `Live Url (all)`: Access details of live URLs for all users.
* `View`: Can see all live URL details.
* `Delete`: Can revoke any live URLs.
* `Live Chart Url (individual)`: Access details of live URLs owned by the user.
* `Live Url (individual)`: Access details of live URLs owned by the user.
* `View`: Can see own live URL details.
* `Modify`: Can update the time period of the URLs to remain live.

Check notice on line 144 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L144

[new-relic.ComplexWords] Consider using 'change' instead of 'Modify'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'change' instead of 'Modify'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 144, "column": 15}}}, "severity": "INFO"}

Check notice on line 144 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L144

[Microsoft.Wordiness] Consider using 'time' instead of 'time period'.
Raw output
{"message": "[Microsoft.Wordiness] Consider using 'time' instead of 'time period'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 144, "column": 39}}}, "severity": "INFO"}
* `Delete`: Can revoke own live URLs.
Expand All @@ -49,6 +151,9 @@ As an Administrator perform the following steps to grant access to a user for [m
1. Add the user under <DNT>**Members**</DNT>.
2. Associate the custom role with the desired account under <DNT>**Account access**</DNT> for dashboard sharing.
3. If the dashboard data spans multiple accounts, include the custom role for each relevant account within the group.

Check notice on line 153 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L153

[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
Raw output
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 153, "column": 12}}}, "severity": "INFO"}

Check notice on line 153 in src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx#L153

[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts.mdx", "range": {"start": {"line": 153, "column": 40}}}, "severity": "INFO"}
<Callout variant="tip">
Ensure you have the sharing capabilities defined for all accounts queried in the dashboard.
</Callout>
</Step>

</Steps>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,15 @@ freshnessValidatedDate: never
---
In New Relic, you can share dashboards and charts with viewers outside your organization, even if they don't have a New Relic account. This feature expands the audience for your insights while maintaining security controls and auditing capabilities. The shared dashboards and charts are accessible via publicly accessible live URLs that you create from the New Relic platform.

When external users access the shared dashboards or charts, the page renders with the same data and visualizations as the original entity, with the only interactive capability being the adjustment of the time range. Each time viewers access the live URLs, it consumes your allocated [CCU](/docs/licenses/license-information/product-definitions/new-relic-one-pricing-definitions/#compute-capacity-unit) limit. If usage exceeds this limit, [additional charges](/docs/accounts/accounts-billing/new-relic-one-pricing-billing/add-on-billing) may apply.
When external users access the shared dashboards or charts, the page renders with the same data and visualizations as the original entity, with the following interactive capabilities:
* **Time range**: Viewers can pick the time range from a drop-down to see data for a specific period.
* **View mode**: Viewers can select light or dark mode depending on their preference.
* **TV mode**: Viewers can enable a full-screen TV mode that optimizes the dashboard for display on a television screen.

Each time viewers access the live URLs, it consumes your allocated [CCU](/docs/licenses/license-information/product-definitions/new-relic-one-pricing-definitions/#compute-capacity-unit) limit. If usage exceeds this limit, [additional charges](/docs/accounts/accounts-billing/new-relic-one-pricing-billing/add-on-billing) may apply.

Check notice on line 21 in src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx#L21

[new-relic.ComplexWords] Consider using 'more' or 'extra' instead of 'additional'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'more' or 'extra' instead of 'additional'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx", "range": {"start": {"line": 21, "column": 224}}}, "severity": "INFO"}

<Callout variant="caution"> Anyone with the live dashboard or chart URLs can view all the information from the dashboard or chart. Share information carefully and in accordance with your company's internal policies and procedures.</Callout>

<Callout variant="caution"> Anyone with the live dashboard or chart URLs can view all the information from the dashboard or chart. Share information carefully and in accordance with your company's internal policies and procedures.</Callout>

Check notice on line 24 in src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx#L24

[new-relic.Adverbs] Consider removing 'carefully'.
Raw output
{"message": "[new-relic.Adverbs] Consider removing 'carefully'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx", "range": {"start": {"line": 24, "column": 150}}}, "severity": "INFO"}

## Prerequisites [#prerequisites-public-dashboard]
This feature includes multiple security layers and conditions to ensure controlled and secure data sharing. To share dashboards or charts publicly, ensure the following setup is in place. Refer to the [Security and access management](/docs/query-your-data/explore-query-data/dashboards/Prerequisites-to-share-dashboards-charts) for setup details:

Check notice on line 27 in src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx#L27

[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx", "range": {"start": {"line": 27, "column": 23}}}, "severity": "INFO"}
Expand All @@ -31,7 +36,7 @@ This feature includes multiple security layers and conditions to ensure controll
## Share your dashboard [#share-dashboard]
You can share your dashboard by generating a live dashboard URL and managing its expiration duration. Additionally, you can view the list of generated URLs with details and revoke them at any time from the New Relic platform. To ensure security and compliance, monitor the audit trail for creating, updating, or revoking shared dashboard URLs.

Check notice on line 37 in src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx#L37

[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'check' or 'watch' instead of 'monitor'.", "location": {"path": "src/content/docs/query-your-data/explore-query-data/dashboards/share-charts-dashbords-externally.mdx", "range": {"start": {"line": 37, "column": 262}}}, "severity": "INFO"}

<Callout variant="caution">You can also create and manage live dashboard URLs through the [NerdGraph API](/docs/apis/nerdgraph/examples/manage-live-dashboard-urls-via-api). </Callout>
<Callout variant="caution">You can also create and manage live dashboard URLs through the [NerdGraph API](/docs/apis/nerdgraph/examples/manage-live-dashboard-urls-via-api). </Callout>

### Create a live dashboard URL [#create-dashboard-url]
To create a publicly accessible live URL for your dashboard:
Expand Down

0 comments on commit fe0b3d3

Please sign in to comment.