조직 추가

POST/orgunits

조직을 추가한다.

주의

  • 조직 추가/수정/부분 수정/이동 API는 도메인당 반드시 단일 스레드로 1초에 한 번, 순서대로 호출한다.

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

directory
orgunit

HTTP Request

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

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required
Content-Typestring

application/json


required
example : application/json

Request Body

PropertyTypeDescription
domainIdinteger

도메인 ID


required
format : int32
orgUnitExternalKeystring

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

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


maxLength : 100
nullable : true
orgUnitNamestring

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


required
maxLength : 100
i18nNamesarray (OrgUnitI18nName)

다국어 이름 목록

emailstring

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

  • 전체 90자 제한
  • localPart 64자 이하

maxLength : 90
descriptionstring

조직 설명


maxLength : 160
nullable : true
visibleboolean

조직 공개 여부
상위조직이 비공개일 경우, false 만 선택가능


default : true
parentOrgUnitIdstring

부모 조직 ID

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

nullable : true
displayOrderinteger

부모 조직이 동일한 조직 간의 순서.


required
minimum : 1
format : int32
aliasEmailsarray (string)

보조 메일 주소 목록


minItems : 0
maxItems : 20
canReceiveExternalMailboolean

외부 메일 수신 여부


default : false
useMessageboolean

조직 대화방 사용 여부


default : false
useNoteboolean

조직 노트 사용 여부


default : false
useCalendarboolean

조직 일정 사용 여부


default : false
useTaskboolean

조직 할일 사용 여부


default : false
useFolderboolean

조직 폴더 사용 여부


default : false
useServiceNotificationboolean

서비스 알림 사용 여부


default : false
membersAllowedToUseOrgUnitEmailAsRecipientarray (OrgUnitAllowedMember)

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


minItems : 0

OrgUnitI18nName

PropertyTypeDescription
languagestring

다국어 언어


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW
namestring

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


required
maxLength : 100

OrgUnitAllowedMember

PropertyTypeDescription
userIdstring

구성원 ID


required

Request Example

example

1{
2  "domainId": 10000001,
3  "orgUnitExternalKey": "externalKeyValue",
4  "orgUnitName": "name01",
5  "i18nNames": [
6    {
7      "language": "en_US",
8      "name": "Team01"
9    }
10  ],
11  "email": "team01@example.com",
12  "description": "desc",
13  "visible": true,
14  "parentOrgUnitId": "parernt9-ffda-4395-24a8-03fb9e22e051",
15  "displayOrder": 1,
16  "aliasEmails": [
17    "alias@example.com"
18  ],
19  "canReceiveExternalMail": true,
20  "useMessage": true,
21  "useNote": true,
22  "useCalendar": true,
23  "useTask": true,
24  "useFolder": true,
25  "useServiceNotification": true,
26  "membersAllowedToUseOrgUnitEmailAsRecipient": [
27    {
28      "userId": "e7b4f7da-f82c-4284-13e7-030f3b4c7569"
29    }
30  ],
31  "displayLevel": 1
32}

Response

HTTP 201

OK

PropertyTypeDescription
domainIdinteger

도메인 ID


required
format : int32
orgUnitIdstring

리소스 ID


readOnly : true
orgUnitExternalKeystring

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

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


maxLength : 100
nullable : true
orgUnitNamestring

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


required
maxLength : 100
i18nNamesarray (OrgUnitI18nName)

다국어 이름 목록

emailstring

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

  • 전체 90자 제한
  • localPart 64자 이하

maxLength : 90
descriptionstring

조직 설명


maxLength : 160
nullable : true
visibleboolean

조직 공개 여부


default : true
parentOrgUnitIdstring

부모 조직 ID

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

nullable : true
parentExternalKeystring

부모 조직 외부 키


readOnly : true
nullable : true
displayOrderinteger

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


minimum : 1
format : int32
displayLevelinteger

조직 깊이(1부터 시작)


minimum : 1
format : int32
readOnly : true
aliasEmailsarray (string)

보조 메일 주소 목록


minItems : 0
maxItems : 20
canReceiveExternalMailboolean

외부 메일 수신 여부


default : false
useMessageboolean

조직 대화방 사용 여부


default : false
useNoteboolean

조직 노트 사용 여부


default : false
useCalendarboolean

조직 일정 사용 여부


default : false
useTaskboolean

조직 할일 사용 여부


default : false
useFolderboolean

조직 폴더 사용 여부


default : false
useServiceNotificationboolean

서비스 알림 사용 여부


default : false
membersAllowedToUseOrgUnitEmailAsRecipientarray (OrgUnitAllowedMember)

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


minItems : 0
membersAllowedToUseOrgUnitEmailAsSenderarray (OrgUnitAllowedMember)

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


minItems : 0

OrgUnitI18nName

PropertyTypeDescription
languagestring

다국어 언어


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW
namestring

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


required
maxLength : 100

OrgUnitAllowedMember

PropertyTypeDescription
userIdstring

구성원 ID


required
userExternalKeystring

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


readOnly : true
nullable : true

Response Example

example

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

HTTP 400

Bad Request