Please check gitlab-tutorial

Skip to content

Create an audit report by using GraphQL

DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

You can create an audit report for a specific subset of users by using:

Use GraphiQL

You can use GraphiQL to query information about a subset of users.

  1. Open GraphiQL:

    • For GitLab.com, use: https://gitlab.com/-/graphql-explorer
    • For self-managed GitLab, use: https://gitlab.example.com/-/graphql-explorer

  2. Copy the following text and paste it in the left window. This query searches for a subset of users by username. Alternately, you can use their Global ID.

    {
  users(usernames: ["user1", "user2", "user3"]) {
    pageInfo {
      endCursor
      startCursor
      hasNextPage
    }
    nodes {
      id
      ...memberships
    }
  }
}

fragment membership on MemberInterface {
  createdAt
  updatedAt
  accessLevel {
    integerValue
    stringValue
  }
  createdBy {
    id
  }
}

fragment memberships on User {
  groupMemberships {
    nodes {
      ...membership
      group {
        id
        name
      }
    }
  }

  projectMemberships {
    nodes {
      ...membership
      project {
        id
        name
      }
    }
  }
}

  3. Select Play.

NOTE: The GraphQL API returns a GlobalID, rather than a standard ID. It also expects a GlobalID as an input rather than a single integer.

This query returns the groups and projects that the user has been explicitly made a member of.

  • Because GraphiQL uses the session token to authorize access to resources, the output is limited to the projects and groups accessible to the currently authenticated user.
  • If you are signed in as an instance administrator, you have access to all resources.

Pagination and graph nodes

The query includes:

pageInfo

This contains the data needed to implement pagination. GitLab uses cursor-based pagination. For more information, see Pagination in the GraphQL documentation.

nodes

In a GraphQL query, nodes represents a collection of nodes on a graph. In this case, the collection of nodes is a collection of User objects. For each one, the output includes:

  • The user's id.
  • The membership fragment, which represents project or group membership that belongs to that user. Fragments are indicated by the ...memberships notation.

Related topics