Method: groups.list

userKey (페이지로 나옴)가 지정된 도메인 또는 사용자의 모든 그룹을 검색합니다.

HTTP 요청

GET https://admin.googleapis.com/admin/directory/v1/groups

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
customer

string

고객 Google Workspace 계정의 고유 ID입니다. 다중 도메인 계정의 경우 한 고객의 모든 그룹을 가져오려면 domain 대신 이 필드를 사용합니다. my_customer 별칭을 사용하여 계정의 customerId을 나타낼 수도 있습니다. customerId도 Users 리소스의 일부로 반환됩니다. customer 또는 domain 매개변수를 제공해야 합니다.
domain

string

도메인 이름입니다. 이 입력란을 사용하여 하나의 도메인에서만 그룹을 가져올 수 있습니다. 고객 계정의 모든 도메인을 반환하려면 대신 customer 쿼리 매개변수를 사용하세요.
maxResults

integer

반환할 결과의 최대 수입니다. 허용되는 최댓값은 200입니다.
orderBy

enum (OrderBy)

결과 정렬에 사용할 열
pageToken

string

목록의 다음 페이지를 지정하는 토큰입니다.
query

string

쿼리 문자열 검색 '' 형식이어야 합니다. 전체 문서는 https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups를 참고하세요.
sortOrder

enum (SortOrder)

결과를 오름차순 또는 내림차순으로 반환할지 여부입니다. orderBy도 사용되는 경우에만 사용합니다.
userKey

string

해당 그룹만 나열되는 경우 지정된 사용자가 속한 사용자의 이메일 또는 변경할 수 없는 ID입니다. ID인 경우에는 사용자 객체의 ID와 일치해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
필드
kind

string

리소스의 유형입니다.
etag

string

리소스의 eETag입니다.
groups[]

object (Group)

그룹 객체의 목록입니다.
nextPageToken

string

이 결과의 다음 페이지에 액세스하는 데 사용되는 토큰입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

자세한 내용은 승인 가이드를 참조하세요.

OrderBy

열거형
EMAIL 그룹의 이메일입니다.

SortOrder

열거형
ASCENDING 오름차순
DESCENDING 내림차순입니다.