GET/users/{userId}/orgunits

구성원이 소속된 조직 목록을 조회한다.

원직 및 겸직 조직을 모두 포함한다.

  • membershipType=ALL(기본): 하위 조직을 통해 간접적으로 소속된 조직도 포함하여 반환한다.
  • membershipType=DIRECT: 구성원이 직접 등록된 조직만 반환한다.

Authorization

oauth2

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

Scope

user
user.read
directory
directory.read

HTTP Request

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

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
orgUnits array (UserOrgUnit) 

조직 정보 목록

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

UserOrgUnit

PropertyTypeDescription
orgUnitId string 

조직 ID


readOnly : true 
domainId integer 

도메인 ID


format : int32 
orgUnitName string 

조직명

 
isPrimaryOrgUnit boolean 

대표 조직 여부

 
isPrimaryOrganization boolean 

원소속 회사 소속 여부

 
useTeamFeature boolean 

조직 기능 사용 여부

 
visible boolean 

구성원 공개 여부

 
isManager boolean 

조직장 여부

 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "orgUnits": [3    {4      "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",5      "domainId": 10000001,6      "orgUnitName": "개발팀",7      "isPrimaryOrgUnit": true,8      "isPrimaryOrganization": true,9      "useTeamFeature": true,10      "visible": true,11      "isManager": false12    }13  ],14  "responseMetaData": {15    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="16  }17}

HTTP 403

Forbidden

HTTP 404

Not Found