GET/users/{userId}/groups

구성원이 속한 그룹 목록을 조회한다.

  • membershipType=ALL(기본): 조직이나 그룹을 통해 간접적으로 소속된 그룹도 포함하여 반환한다. 그룹 마스터이지만 그룹 멤버가 아닌 경우도 포함된다.
  • membershipType=DIRECT: 구성원이 직접 등록된 그룹만 반환한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

directory
directory.read
user
user.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/groups

Path Parameters

ParameterTypeDescription
userId string 

구성원 ID
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
count integer 

조회 개수


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
membershipType string 

ALL(기본): 조직이나 그룹을 통해 간접적으로 소속된 그룹도 포함하여 반환한다. 그룹 마스터이지만 그룹 멤버가 아닌 경우도 포함된다.
DIRECT: 구성원이 직접 등록된 그룹만 반환한다.


default : ALL
Allowed values : DIRECT, ALL 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
groups array (UserGroup) 

그룹 정보 목록

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

UserGroup

PropertyTypeDescription
groupId string 

그룹 ID


readOnly : true 
domainId integer 

도메인 ID


format : int32 
groupName string 

그룹명

 
isGroupAdministrator boolean 

그룹 마스터 여부

 
isGroupMember boolean 

그룹 멤버 여부. membershipType=ALL일 때 그룹 마스터이지만 멤버가 아닌 경우 false가 될 수 있다.

 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값

 

Response Example

example

1{2  "groups": [3    {4      "groupId": "group127-8545-4463-603b-04d550d23bf",5      "domainId": 10000001,6      "groupName": "그룹1",7      "isGroupAdministrator": false,8      "isGroupMember": true9    }10  ],11  "responseMetaData": {12    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="13  }14}

HTTP 403

Forbidden

HTTP 404

Not Found