You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/apis/nerdgraph/examples/nerdgraph-api-secret-management-service.mdx
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,24 @@ metaDescription: "Learn how to use the Secret Management Service to securely sto
4
4
freshnessValidatedDate: never
5
5
---
6
6
7
-
When you're working with New Relic, you might need to store sensitive information like API keys and application credentials. In New Relic, these are called secrets. The <dnt>secrets management</dnt> service provides a secure way to store and retrieve these secrets in a centralized location through our [NerdGraph API](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph/). You can store secrets only in string format.
7
+
When you're working with New Relic, you might need to store sensitive information like API keys and application credentials. In New Relic, these are called secrets. The <dnt>secrets management</dnt> service provides a secure way to store and retrieve these secrets in a centralized location through our [NerdGraph API](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph/).
8
8
9
+
<Calloutvariant="important">
10
+
11
+
You can store secrets only in string format.
12
+
13
+
</Callout>
9
14
10
-
The key features of the <dnt>secrets management</dnt> service are as follows:
15
+
The key features of the <dnt>secrets management</dnt> service are:
11
16
12
-
***Unique keys for secrets**: You need to assign a unique key to each secret you store. This key is used to identify the secret when you want to retrieve or manage it.
17
+
***Unique keys for secrets**: You can prevent accidental exposure of secrets by assigning a unique key to each one when storing. Use the key to retrieve and manage the secrets.
13
18
14
-
***Secrets at [account or organization level](/docs/accounts/accounts-billing/account-structure/new-relic-account-structure/)**: If a secret must be accessed and used across multiple accounts, you can store it at the organization level. Conversely, if the secret is specific to an account and does not need cross-account access, you can store it at the account level.
19
+
***Secrets stored at [account or organization level](/docs/accounts/accounts-billing/account-structure/new-relic-account-structure/)**:
20
+
To access and use a secret across multiple accounts, you can store it at the organization level. For a secret is specific to a single account, you can store it at the account level.
15
21
16
22
***Versions of secrets**: You can update a secret without losing the previous version. The <dnt>secrets management</dnt> service tracks all versions of a secret, allowing you to retrieve up to 10 previous versions.
17
23
18
-
***Soft delete and secrets recovery**: You can temporarily delete a secret and recover it later. This is useful if you accidentally delete a secret or need to restore a previous version. You can also purge a secret, which permanently removes it from the system.
24
+
***Temporary deletion and recovery of secrets**: You can delete a secret temporarily and recover it later, which is useful for restoring previous versions.
19
25
20
26
***Access control**: As an admin, you can define who can access the secret by setting custom roles and permissions, and specifying the scope of access. The scope can range from basic read-only access to purge access.
21
27
@@ -190,7 +196,7 @@ The operations you can perform with the <dnt>secrets management</dnt> service ar
190
196
<CollapserGroup>
191
197
<Collapser
192
198
id="create-secret"
193
-
title="store a secret">
199
+
title="Store a secret">
194
200
195
201
Use the `secretsManagementCreateSecret` mutation with the following partameters to store a secret.
196
202
@@ -258,7 +264,7 @@ Use the `secretsManagementCreateSecret` mutation with the following partameters
258
264
</td>
259
265
<td>
260
266
261
-
*`type`: Based on your permission and need, select `Account` or `Organization`.
267
+
*`type`: Based on your permissions and requirements, select `Account` or `Organization`.
262
268
* `id`: Enter the corresponding ID of the account or organization.
263
269
</td>
264
270
</tr>
@@ -407,7 +413,7 @@ mutation {
407
413
Use the `secretsManagementUpdateSecret` mutation to update the value of existing secrets.
408
414
409
415
<Callout variant="tip">
410
-
Each update operation creates a new version of the secret. The highest version is always the latest version of the secret.
416
+
Each update operation creates a new version of the secret. The highest version is always the latest version of the secret. To rertieve older versions of the secret, you can use the `{customerAdministration {secretVersions}}` query. For more details, refer to the [Retrieve all versions of a secret](/#recover-secrets-versions) section.
0 commit comments