Create custom roles for Teams

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.

Default Teams access

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

Action	Required role
View teams	Organization read only
Modify teams	Organization Product Admin
Create and delete teams	Organization Manager or Authentication Manager

You might need a custom role if the default permissions don't meet your organization's needs.

Teams capabilities

When building a custom role for Teams, use the permissions below. Teams permissions are organization-scoped.

Capability	Permission identifier
Read teams	`teams.read.team`
Delete teams	`teams.delete.team`
Create teams	`teams.create.team`
Modify teams	`teams.update.team`
Read access to the automations/settings page	`teams.read.organization_settings`
Modify access to the automations/settings page	`teams.manage.organization_settings`
Create teams from IdP user groups (for example, Okta)	`authentication_domain.read.groups`

Prerequisites

Before you begin, ensure you have:

General NerdGraph requirements
Organization Admin with Authentication Domain Manager role to create custom roles

Tip

You can also create a custom role for Teams through the UI. For the permissions to select and the scope to use, see Teams capabilities.

To create a custom role via the NerdGraph API, perform the following steps:

Find the required permission IDs for Teams

Use the customerAdministration query to retrieve a list of capabilities, their permission IDs, and related information. Filter by scope: "organization" to get Teams permissions.

Input parameters

Parameter	Data Type	Is it Required?	Description
`eq`	String	Yes	Set the value to `organization` to retrieve permissions for Teams.

Sample request

{
  customerAdministration {
    permissions(filter: { scope: { eq: "organization" } }) {
      items {
        feature
        category
        id
        product
      }
    }
  }
}

Sample response

{
  "data": {
    "customerAdministration": {
      "permissions": {
        "items": [
          {
            "category": "READ",
            "feature": "Teams",
            "id": "xxxxx",
            "product": "New Relic One"
          },
          {
            "category": "OTHER",
            "feature": "Teams",
            "id": "xxxxxx",
            "product": "New Relic One"
          },
          {
            "category": "DELETE",
            "feature": "Teams",
            "id": "xxxxx",
            "product": "New Relic One"
          },
          {
            "category": "MODIFY",
            "feature": "Teams",
            "id": "xxxxxx",
            "product": "New Relic One"
          }
        ]
      }
    }
  }
}

From the response, identify and copy the permission IDs where feature is "Teams" and the category matches the access level you want to grant. You'll need these IDs in the next step.

Retrieve your organization ID

Retrieve your organization ID, which you'll use in subsequent mutations.

Sample request

{
  actor {
    organization {
      id
    }
  }
}

Sample response

{
  "data": {
    "actor": {
      "organization": {
        "id": "YOUR_ORGANIZATION_ID"
      }
    }
  }
}

Copy your organization ID from the response. You'll need it to create the custom role.

Create the custom role

Use the customRoleCreate mutation to create your custom role for Teams management.

Input parameters

Parameter	Data Type	Is it Required?	Description
`id`	String	Yes	The organization ID from the previous step.
`type`	String	Yes	Set to `organization`.
`name`	String	Yes	The display name for the custom role.
`permissionIds`	Array of Integers	Yes	The Teams permission IDs identified in Step 1.
`scope`	String	Yes	Set to `organization`.

Sample request

mutation {
  customRoleCreate(
    container: { id: "YOUR_ORGANIZATION_ID", type: "organization" }
    name: "Teams manager"
    permissionIds: [xxxxx, xxxxx]
    scope: "organization"
  ) {
    id
  }
}

Sample response

{
  "data": {
    "customRoleCreate": {
      "id": 9999999
    }
  }
}

Save the returned role ID — you'll need it to assign this role to a user group.

Add the custom role to a user group

After creating the custom role, assign it to a user group in New Relic.

Retrieve group IDs

Use the customerAdministration query to get a list of available user groups.

Input parameters

Parameter	Data Type	Is it Required?	Description
`id`	String	Yes	The organization ID from the previous step.

Sample request

{
  customerAdministration {
    groups(filter: { organizationId: { eq: "YOUR_ORGANIZATION_ID" } }) {
      nextCursor
      items {
        id
        name
        users {
          items {
            id
            email
          }
        }
      }
    }
  }
}

From the response, copy the group ID for the group you want to assign the Teams role to.

Assign the role to the group

Use the authorizationManagementGrantAccess mutation to assign the custom role to a user group.

Input parameters

Parameter	Data Type	Is it Required?	Description
`roleId`	String	Yes	The custom role ID from the previous step.
`groupId`	String	Yes	The group ID retrieved above.

Sample request

mutation {
  authorizationManagementGrantAccess(
    grantAccessOptions: {
      organizationAccessGrants: { roleId: "YOUR_ROLE_ID" }
      groupId: "YOUR_GROUP_ID"
    }
  ) {
    roles {
      id
      name
      organizationId
      roleId
      groupId
      displayName
    }
  }
}

Sample response

{
  "data": {
    "authorizationManagementGrantAccess": {
      "roles": [
        {
          "displayName": "Teams manager",
          "groupId": null,
          "id": "99999999",
          "name": "teams_manager",
          "organizationId": "YOUR_ORGANIZATION_ID",
          "roleId": 99999
        }
      ]
    }
  }
}

Manage existing custom roles

Use the customRoleUpdate mutation to rename a role or replace its permission set.

mutation {
  customRoleUpdate(
    id: ROLE_ID
    name: "Updated role name"
    permissionIds: [xxxxx, xxxxx]
  ) {
    id
  }
}

Parameter	Description
`id`	The ID of the role to update.
`name`	New display name for the role.
`permissionIds`	Full replacement list of permission IDs. This replaces all existing permissions on the role.

Use the customRoleDelete mutation to permanently remove a custom role.

mutation {
  customRoleDelete(id: ROLE_ID) {
    id
  }
}

The response returns the ID of the deleted role, confirming successful deletion.

Use the following query to look up a role ID by browsing your organization's groups and their assigned roles.

{
  actor {
    organization {
      authorizationManagement {
        authenticationDomains(id: "YOUR_AUTHENTICATION_DOMAIN_ID") {
          authenticationDomains {
            groups {
              groups {
                displayName
                id
                roles {
                  roles {
                    roleId
                    name
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

For more information about Teams, see the Teams documentation.

Default Teams access

Teams capabilities

Prerequisites

Tip

Find the required permission IDs for Teams

Input parameters

Sample request

Sample response

Retrieve your organization ID

Sample request

Sample response

Create the custom role

Input parameters

Sample request

Sample response

Add the custom role to a user group

Retrieve group IDs

Input parameters

Sample request

Assign the role to the group

Input parameters

Sample request

Sample response

Manage existing custom roles

Update a role

Delete a role

Find a custom role's ID

Create custom roles for Teams

Default Teams access .css-21sua1{background:none;border:none;width:0;padding:0;}

Teams capabilities

Prerequisites

Tip

Find the required permission IDs for Teams

Input parameters

Sample request

Sample response

Retrieve your organization ID

Sample request

Sample response

Create the custom role

Input parameters

Sample request

Sample response

Add the custom role to a user group

Retrieve group IDs

Input parameters

Sample request

Assign the role to the group

Input parameters

Sample request

Sample response

Manage existing custom roles

Delete a role

Find a custom role's ID

Default Teams access