GET/groups/{groupId}/members

그룹 구성원 목록을 조회한다. 외부 그룹은 조회할 수 없다.

Authorization

oauth2

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

Scope

directory
directory.read
group
group.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/groups/{groupId}/members

Path Parameters

ParameterTypeDescription
groupId string 

그룹 ID 또는 외부 키.
외부 키는 "externalKey:{externalKey}" 형태


required 

Query Parameters

ParameterTypeDescription
domainId integer 

도메인 ID


example : 10000001
format : int32 
count integer 

조회 개수


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

커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Response

HTTP 200

OK

PropertyTypeDescription
members array (GroupMember) 

그룹 구성원 목록

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

GroupMember

PropertyTypeDescription
externalKey string 

구성원 외부 키


readOnly : true 
id string 

구성원,조직,그룹의 ID
구성원 ID는 다음을 지정 가능
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required 
type string 

required
Allowed values : USER, ORGUNIT, GROUP 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "members": [3    {4      "externalKey": "USER_EXT_01",5      "id": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "type": "USER"7    },8    {9      "externalKey": "ORGUNIT_EXT_01",10      "id": "orgunitf-f27f-4af8-27e1-03817a911417",11      "type": "ORGUNIT"12    },13    {14      "externalKey": "GROUP_EXT_01",15      "id": "group769-e656-477d-69c7-04e2f73a4a77",16      "type": "GROUP"17    }18  ],19  "responseMetaData": {20    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="21  }22}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found