GET/orgunits

조직 목록을 조회한다.

Authorization

oauth2

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

Scope

directory
directory.read
orgunit
orgunit.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/orgunits

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 

Response

HTTP 200

OK

PropertyTypeDescription
orgUnits array (OrgUnit) 

조직 목록

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

OrgUnit

PropertyTypeDescription
domainId integer 

도메인 ID


required
format : int32 
orgUnitId string 

리소스 ID


readOnly : true 
orgUnitExternalKey string 

고객사에서 관리하는 외부 키

%, \, #, /, ? 포함 불가


maxLength : 100
nullable : true 
orgUnitName string 

조직명. 특수 문자 중 ! @ & ( ) - _ + [ ] { } , . /만 허용된다.


required
maxLength : 100 
i18nNames array (OrgUniti18nName) 

다국어 이름 목록

 
email string 

조직 메일 주소(localpart@domain 또는 localpart@group) 조직을 수정할 때는 필수로 입력해야 한다.

  • 전체 90자 제한
  • localpart는 영문 소문자, 숫자, 느낌표(!) 또는 샵(#)으로 시작해야 한다.
  • 점(.)은 localpart의 시작과 끝에 사용할 수 없으며, 연속된 형태(..)로도 사용할 수 없다.
  • localpart는 2~64자의 영문 소문자, 숫자, 점(.), 하이픈(-), 밑줄(_), 느낌표(!), 샵(#)을 허용한다.

maxLength : 90 
description string 

조직 설명


maxLength : 160
nullable : true 
visible boolean 

조직 공개 여부


default : true 
parentOrgUnitId string 

부모 조직 ID

  • 리소스 ID
  • 외부 키 "externalKey:{orgUnitExternalKey}" 형태

nullable : true 
parentExternalKey string 

부모 조직 외부 키


readOnly : true
nullable : true 
displayOrder integer 

부모 조직이 동일한 조직 간의 순서. 조직을 추가할 때만 필수값으로 사용된다. 수정시에는 해당 값은 무시된다.


minimum : 1
format : int32 
displayLevel integer 

조직 깊이(1부터 시작)


minimum : 1
format : int32
readOnly : true 
aliasEmails array (string) 

보조 메일 주소 목록.

  • 네이버웍스 코어 Standard, Standard Plus 상품만 사용 가능

minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

외부 메일 수신 여부

  • 네이버웍스 코어 Standard, Standard Plus 상품만 사용 가능

default : false 
useMessage boolean 

메시지방 사용 여부.

  • 네이버웍스 코어 상품만 사용 가능
  • false로 설정하면 30일 후 모든 구성원의 대화 기록 및 메시지방 기능(노트, 캘린더, 폴더, 할 일) 데이터가 삭제된다.
  • false로 설정한 후 30일 내에 다시 true로 설정하면 이전 데이터가 복구된다. 30일이 지난 후에 true로 설정하면 이전 데이터는 복구되지 않으며 새로운 메시지방이 생성된다.

default : false 
useNote boolean 

메시지방 노트 사용 여부.

  • false로 설정하면 노트 기능을 사용하지 않는다. 이전 데이터를 다시 확인하려면 이 파라미터를 true로 설정한다.
  • useMessage가 true일 때만 설정할 수 있다.

default : false 
useCalendar boolean 

메시지방 캘린더 사용 여부.

  • false로 설정하면 캘린더 기능을 사용하지 않는다. 이전 데이터를 다시 확인하려면 이 파라미터를 true로 설정한다.
  • useMessage가 true일 때만 설정할 수 있다.

default : false 
useTask boolean 

메시지방 할 일 사용 여부.

  • false로 설정하면 할 일 기능을 사용하지 않는다. 이전 데이터를 다시 확인하려면 이 파라미터를 true로 설정한다.
  • useMessage가 true일 때만 설정할 수 있다.

default : false 
useFolder boolean 

메시지방 폴더 사용 여부.

  • false로 설정하면 폴더 기능을 사용하지 않는다. 이전 데이터를 다시 확인하려면 이 파라미터를 true로 설정한다.
  • useMessage가 true일 때만 설정할 수 있다.

default : false 
useServiceNotification boolean 

서비스 알림 사용 여부


default : false 
membersAllowedToUseOrgUnitEmailAsRecipient array (OrgUnitAllowedMember) 

조직 메일 주소에 메일을 보낼 수 있는 구성원 목록

  • 네이버웍스 코어 Standard, Standard Plus 상품만 사용 가능

minItems : 0 
membersAllowedToUseOrgUnitEmailAsSender array (OrgUnitAllowedMember) 

해당 조직 메일 주소를 보내는 주소로 사용할 수 있는 구성원 목록 조직원만 지정 가능


minItems : 0 

OrgUniti18nName

PropertyTypeDescription
language string 

다국어 언어


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
name string 

다국어 이름. 특수 문자는 ! @ & ( ) - _ + [ ] { } , . /만 허용된다.


required
maxLength : 100 

OrgUnitAllowedMember

PropertyTypeDescription
userId string 

구성원 ID


required 
userExternalKey string 

고객사에서 관리하는 외부 키


readOnly : true
nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "orgUnits": [3    {4      "domainId": 10000001,5      "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",6      "orgUnitExternalKey": "externalKeyValue",7      "orgUnitName": "name01",8      "i18nNames": [9        {10          "language": "en_US",11          "name": "Team01"12        }13      ],14      "email": "team01@example.com",15      "description": "desc",16      "visible": true,17      "parentOrgUnitId": "parernt9-ffda-4395-24a8-03fb9e22e051",18      "parentExternalKey": "parentExtKeyValue",19      "displayOrder": 1,20      "displayLevel": 1,21      "aliasEmails": [22        "alias@example.com"23      ],24      "canReceiveExternalMail": true,25      "useMessage": true,26      "useNote": true,27      "useCalendar": true,28      "useTask": true,29      "useFolder": true,30      "useServiceNotification": true,31      "membersAllowedToUseOrgUnitEmailAsRecipient": [32        {33          "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",34          "userExternalKey": "userExtKeuy"35        }36      ],37      "membersAllowedToUseOrgUnitEmailAsSender": [38        {39          "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569",40          "userExternalKey": "userExtKeuy"41        }42      ]43    }44  ],45  "responseMetaData": {46    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="47  }48}