GraphQL을 사용하여 사용자 쿼리

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

이 페이지에서는 GraphiQL 탐색기를 사용하여 사용자를 쿼리하는 방법에 대해 설명합니다.

같은 쿼리를 직접 HTTP 엔드포인트를 통해 실행하여 cURL을 사용할 수 있습니다. 더 자세한 내용은 명령줄에서 시작하는 방법을 참조하세요.

예제 사용자 쿼리는 GitLab 인스턴스의 일부 사용자를 유저 이름 또는 Global ID로 찾습니다. 이 쿼리에는 다음이 포함됩니다:

pageInfo

이것에는 페이지네이션을 구현하는 데 필요한 데이터가 포함되어 있습니다. GitLab은 커서 기반의 페이지네이션을 사용합니다. 더 많은 정보는 GraphQL 문서의 페이지네이션을 참조하세요.

nodes

GraphQL 쿼리에서 nodes는 그래프의 노드 컬렉션을 나타내기 위해 사용됩니다. 이 경우, 노드의 컬렉션은 User 객체의 컬렉션입니다. 각각에 대해, 우리는 다음을 출력합니다:

  • 그들의 유저 id.
  • 그 유저에게 속한 프로젝트 또는 그룹 멤버십을 나타내는 membership 프래그먼트. 프래그먼트를 출력하는 것은 ...memberships 표기로 나타냅니다.

GitLab GraphQL API는 광범위하며 다양한 엔티티의 대규모 데이터가 출력될 수 있습니다. 가장 최신 정보는 공식 참조 문서를 참조하세요.

GraphiQL 탐색기 설정

이 절차는 GraphiQL 탐색기로 복사하여 붙여넣을 수 있는 구체적인 예제를 제시합니다. GraphiQL 탐색기는 다음에서 사용할 수 있습니다:

  1. 다음의 코드 단락을 복사하세요. 

     {
   users(usernames: ["user1", "user3", "user4"]) {
     pageInfo {
       endCursor
       startCursor
       hasNextPage
     }
     nodes {
       id
       username,
       publicEmail
       location
       webUrl
       userPermissions {
         createSnippet
       }
     }
   }
 }
  2. GraphiQL 탐색기 도구를 엽니다.
  3. 위에서 나열된 query를 GraphiQL 탐색기 도구의 왼쪽 창에 붙여넣으세요.
  4. 결과를 얻기 위해 실행을 선택하세요.

보드를 검색하는 GraphiQL 탐색기

참고: GraphQL API는 표준 ID 대신 GlobalID를 반환합니다. 또한 단일 정수 대신 GlobalID를 입력으로 예상합니다.

이 GraphQL 쿼리는 나열된 유저 이름을 가진 세 명의 유저에 대한 지정된 정보를 반환합니다. GraphiQL 탐색기는 세션 토큰을 사용하여 리소스에 대한 액세스를 승인하므로, 출력은 현재 인증된 사용자가 액세스할 수 있는 프로젝트 및 그룹으로 제한됩니다.

인스턴스 관리자로서 로그인한 경우, 소유권 여부에 관계없이 모든 레코드에 액세스할 수 있습니다.

관리자로서 로그인한 경우, 쿼리의 두 번째 줄에 admins: true 매개 변수를 추가하여 인스턴스에서 일치하는 관리자만 표시할 수 있습니다. 

  users(usernames: ["user1", "user3", "user4"], admins: true) {
    ...
  }

또는 모든 관리자를 가져올 수 있습니다. 

  users(admins: true) {
    ...
  }

추가 정보:

  • 프래그먼트와 인터페이스와 같은 GraphQL 특정 엔티티에 대해서는 공식 GraphQL 문서를 참조하세요.
  • 개별 속성에 대해서는 GraphQL API 리소스를 참조하세요.