GET/orgunits/{orgUnitId}/members

조직 구성원 목록을 조회한다.

Authorization

oauth2

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

Scope

directory
directory.read
orgunit
orgunit.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/orgunits/{orgUnitId}/members

Path Parameters

ParameterTypeDescription
orgUnitId string 

조직 ID
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required
example : orgunitf-f27f-4af8-27e1-03817a911417 

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 (OrgUnitMember) 

조직 구성원 목록

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

OrgUnitMember

PropertyTypeDescription
userId string 

구성원 ID


readOnly : true 
userExternalKey string 

구성원 외부 키


maxLength : 100
readOnly : true
nullable : true 
isManager boolean 

조직장 여부


readOnly : true 
visible boolean 

구성원 공개 여부. 조직도에서 조직의 구성원으로 표시할지 여부를 나타낸다.


readOnly : true 
useTeamFeature boolean 

조직 기능 사용 여부. 조직의 구성원이긴 하나 조직 메시지방에서의 메시지 수신, 파일 공유나 조직 메일 수신과 같은 보안상 중요한 조직 기능을 제한하고자 할 때 이 파라미터를 이용한다. 이 값이 true이면 다음과 같이 조직의 메시지방 기능을 사용할 수 있다. 조직 메시지방(Message/Note/Calendar/Folder)의 구성원으로 참여하여 메시지를 주고 받거나, 노트를 조회하고, 일정을 공유받고, 폴더를 조회할 수 있다.

  • 조직으로 보낸 메일 수신 가능
  • 조직을 대상으로 초대한 일정을 공유받음
  • 조직 캘린더 조회 가능
  • 조직으로 공유한 드라이브의 파일 조회 가능
  • 조직으로 권한을 부여한 게시판 조회 가능
  • 조직을 대상으로 한 설문에 응답 가능
  • 조직을 그룹의 구성원으로 설정한 경우 그룹의 구성원에 포함 이 값이 false이면 조직에 제공되는 위와 같은 모든 조직 기능을 사용할 수 없다. 조직의 구성원이긴 하나 위와 같은 조직 기능을 사용하지 않는다면 이 값을 false로 설정한다.

readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "members": [3    {4      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",5      "userExternalKey": "USER_EXT_01",6      "isManager": true,7      "visible": true,8      "useTeamFeature": true9    }10  ],11  "responseMetaData": {12    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="13  }14}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found