Skip to content

Commit 291c643

Browse files
Added nav files. Updated the documentation
1 parent 8f68d13 commit 291c643

File tree

2 files changed

+54
-49
lines changed

2 files changed

+54
-49
lines changed

src/content/docs/apis/nerdgraph/examples/nerdgraph-teams-custom-role-tutorial renamed to src/content/docs/apis/nerdgraph/examples/nerdgraph-teams-custom-role-tutorial.mdx

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,36 @@ freshnessValidatedDate: never
1717
</Callout>
1818

1919

20-
New Relic Teams lets you connect the entities you're monitoring to the Teams who own them. When you can easily see who owns an entity, you can speed up troubleshooting, enhance team collaboration, and improve your operational efficiency.
20+
New Relic Teams lets you connect the entities you're monitoring to the teams who own them. When you can easily see who owns an entity, you can speed up troubleshooting, enhance team collaboration, and improve your operational efficiency.
2121

22-
We have given access to Teams to these standard roles:
23-
* **Read Access: **All users have read access to Teams, including metadata such as contact information, team members, and other relevant details.
24-
* **Modify Teams: **Users with the **Organization Product Admin** role can modify Teams. This is a new role assigned to all users who currently have the **All Product Admin role**.
25-
* **Create & Delete Teams: **Users with **Organization Manager** or **Authentication Manager** roles can create and delete Teams.
22+
## Default Teams access
2623

24+
New Relic provides default access to Teams through these standard roles:
2725

28-
This section provides instructions on using NerdGraph GraphQL mutations to create a custom role for managing Teams.
26+
* **Read Access**: All users have read access to Teams, including metadata such as contact information, team members, and other relevant details.
27+
* **Modify Teams**: Users with the **Organization Product Admin** role can modify Teams. This is a new role assigned to all users who currently have the **All Product Admin** role.
28+
* **Create & Delete Teams**: Users with **Organization Manager** or **Authentication Manager** roles can create and delete Teams.
2929

30-
To create a Teams administrator custom role, you need to:
3130

32-
* [Retrieve all the organization-scoped capabilities](#retrieve-organization-scoped-capabilities)
33-
* [Retrieve your organization ID](#retrieve-your-organization-id)
34-
* Find the required permission IDs for Teams
35-
* [Create the custom role for Teams administrator](#create-custom-role)
36-
* [Add the custom role to a user group](#add-custom-role-to-a-user-group)
31+
You might need a custom role if the default permissions don't meet your organization's needs. This tutorial shows you how to use NerdGraph GraphQL mutations to create a custom role for managing Teams.
3732

33+
### Process overview
3834

39-
**Prerequisites:**
35+
To create a Teams administrator custom role, you'll need to:
36+
37+
1. [Retrieve all the organization-scoped capabilities](#retrieve-organization-scoped-capabilities)
38+
2. [Retrieve your organization ID](#retrieve-your-organization-id)
39+
3. [Identify the required permission IDs for Teams](#retrieve-organization-scoped-capabilities)
40+
4. [Create the custom role for Teams administrator](#create-custom-role)
41+
5. [Add the custom role to a user group](#add-custom-role-to-a-user-group)
42+
43+
44+
## Prerequisites
45+
46+
Before you begin, ensure you have:
4047

4148
* [General NerdGraph requirements](/docs/apis/nerdgraph/get-started/introduction-new-relic-nerdgraph/#authentication)
42-
* You must be an Organization Admin to create a custom role.
49+
* Organization Admin role permissions to create custom roles
4350

4451

4552
## Mutations [#mutations]
@@ -132,9 +139,11 @@ New Relic provides various NerdGraph mutations to create custom role for Team ma
132139

133140
```
134141

135-
Copy and paste the information related to Teams in a text file matching the following criteria:
136-
* `category: MANAGE`
137-
* `"feature"``: "Teams"`
142+
**Next step**: From the response, identify and copy the permission IDs where:
143+
* `category: "MANAGE"` (or the appropriate category for your needs)
144+
* `feature: "Teams"`
145+
146+
You'll need these IDs for the next step.
138147

139148

140149

@@ -143,8 +152,7 @@ Copy and paste the information related to Teams in a text file matching the foll
143152
id="retrieve-your-organization-id"
144153
title="Retrieve your organization ID">
145154

146-
Fetch your organization ID to use in various mutations further.
147-
155+
Retrieve your organization ID, which you'll use in subsequent mutations.
148156

149157
#### Sample request
150158

@@ -174,14 +182,14 @@ Fetch your organization ID to use in various mutations further.
174182

175183
```
176184

177-
Copy the organization ID and keep it aside to create a role.
185+
**Next step**: Copy your organization ID from the response. You'll need it to create the custom role.
178186

179187
</Collapser>
180188
<Collapser
181189
id="create-custom-role"
182190
title="Create custom role">
183191

184-
Run the `customRoleCreate` mutation to create your own custom role.
192+
Use the `customRoleCreate` mutation to create your custom role for Teams management.
185193

186194

187195
#### Input parameters
@@ -215,10 +223,10 @@ Run the `customRoleCreate` mutation to create your own custom role.
215223
<td>The name of the role.</td>
216224
</tr>
217225
<tr>
218-
<td>`PermissionId`</td>
219-
<td>Int</td>
226+
<td>`permissionId`</td>
227+
<td>Array of Integers</td>
220228
<td>Yes</td>
221-
<td>List the ID's for the feature retrieved using `customerAdministration` mutations for Teams.</td>
229+
<td>The permission IDs for Teams features retrieved in the first step.</td>
222230
</tr>
223231
<tr>
224232
<td>`scope`</td>
@@ -259,34 +267,19 @@ mutation {
259267

260268
```
261269

262-
<table>
263-
<thead>
264-
<tr>
265-
<th>Parameter</th>
266-
<th>Data Type</th>
267-
<th>Description</th>
268-
</tr>
269-
</thead>
270-
<tbody>
271-
<tr>
272-
<td>`id`</td>
273-
<td>Int</td>
274-
<td>The custom role ID. Copy and keep this ID for future use.</td>
275-
</tr>
276-
</tbody>
277-
</table>
270+
**Next step**: Save the returned role ID. You'll need it to assign this role to a user group.
278271

279272
</Collapser>
280273

281274
<Collapser
282275
id="add-custom-role-to-a-user-group"
283276
title="Add custom role to a user group">
284277

285-
After you have created the custom role, you must associate this role with a user group on the New Relic platform.
278+
After creating the custom role, you need to assign it to a user group in New Relic.
286279

287-
### Fetch the group ID
280+
### Step 1: Retrieve group IDs
288281

289-
You can use `customerAdministration` mutation to retrieve the list of group ID's.
282+
Use the `customerAdministration` mutation to get a list of available user groups.
290283

291284

292285
#### Input parameters
@@ -334,11 +327,11 @@ You can use `customerAdministration` mutation to retrieve the list of group ID's
334327

335328
```
336329

337-
From the displayed list of group IDs, copy the desired group ID to associate the custom Scorecard role you created earlier.
330+
**Next step**: From the response, copy the group ID for the group you want to assign the Teams role to.
338331

339-
### Add the rule to a user group
332+
### Step 2: Assign the role to a user group
340333

341-
You can use `authorizationManagementGrantAccess` mutation to add the role to a user group.
334+
Use the `authorizationManagementGrantAccess` mutation to assign the custom role to a user group.
342335

343336

344337
#### Input parameters
@@ -357,13 +350,13 @@ You can use `authorizationManagementGrantAccess` mutation to add the role to a u
357350
<td>`roleId`</td>
358351
<td>String</td>
359352
<td>Yes</td>
360-
<td>The custom role ID created in the [Custom role]() section.</td>
353+
<td>The custom role ID from the previous step.</td>
361354
</tr>
362355
<tr>
363356
<td>`groupId`</td>
364357
<td>String</td>
365-
<td>No</td>
366-
<td>The group ID retrieved in the previous step.</td>
358+
<td>Yes</td>
359+
<td>The group ID from Step 1.</td>
367360
</tr>
368361
</tbody>
369362
</table>
@@ -411,3 +404,13 @@ mutation {
411404
```
412405
</Collapser>
413406
</CollapserGroup>
407+
408+
## What's next
409+
410+
After successfully creating and assigning your custom Teams role, users in the assigned group will have the permissions you configured. You can:
411+
412+
* Monitor the role's usage through your organization's user management
413+
* Modify the role permissions if needed using similar NerdGraph mutations
414+
* Create additional custom roles for different levels of Teams access
415+
416+
For more information about Teams, see our [Teams documentation](/docs/service-architecture-intelligence/teams/teams/).

src/nav/telemetry-data-platform.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ pages:
214214
path: /docs/apis/nerdgraph/examples/nerdgraph-api-secret-management-service
215215
- title: Teams tutorial
216216
path: /docs/apis/nerdgraph/examples/nerdgraph-teams-tutorial
217+
- title: Custom role for Teams
218+
path: /docs/apis/nerdgraph/examples/nerdgraph-teams-custom-role-tutorial
217219
- title: REST APIs
218220
pages:
219221
- title: REST API v2

0 commit comments

Comments
 (0)