Skip to content

sonarUserGroups

Returns a paginated list of user groups visible in the user awareness experience.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String Returns the elements in the list that occur after the specified cursor.
last Int Returns the last n elements from the list.
before String Returns the elements in the list that occur before the specified cursor.
filter ListAccessGroupsFilterInput Optional filter to narrow the returned groups by name or user.

Returns

AccessGroupConnection!

Sample

query {
  sonarUserGroups(first: 10) {
    nodes {
      groupId
      groupName
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{}

{
  "data": {
    "sonarUserGroups": {
      "nodes": [
        [
          {
            "groupId": "example-string",
            "groupName": "example-string"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}