PATCH/groups/{groupId}

resourceId 혹은 고객사가 관리하는 외부 키에 해당하는 그룹을 부분 수정한다. 외부 그룹은 수정할 수 없다.

  • 부분 수정 대상 그룹이 동적 그룹인 경우 조건에 따라 구성원이 자동으로 추가, 삭제되므로 전달하는 members 필드는 무시된다.

Authorization

oauth2

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

Scope

directory
group

HTTP Request

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

Path Parameters

ParameterTypeDescription
groupId string 

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


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

도메인ID


format : int32 
groupName string 

그룹명. 도메인 내에서 유일해야 함.


maxLength : 100 
description string 

그룹 설명


maxLength : 300
nullable : true 
visible boolean 

그룹 공개 여부. 관리자, 구성원이 아닌 사용자의 검색 결과에도 노출할지 여부

 
useServiceNotification boolean 

서비스 알림 발송 여부

 
serviceManageable boolean 

그룹 관리자가 서비스 사용 여부를 변경할 수 있는지 여부

 
groupExternalKey string 

그룹의 외부 키


maxLength : 100
nullable : true 
administrators array (GroupAdministrator) 

그룹의 관리자 목록


minItems : 1 
members array (GroupMember) 

그룹 구성원 목록

 
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 
useMail boolean 

그룹 메일 사용 여부.

  • 네이버웍스 코어 Standard, Standard Plus 상품만 사용 가능
  • 이 값이 true이면 groupEmail 항목도 필수로 입력해야 함.
 
groupEmail string 

그룹 메일 주소(그룹 메일 사용 시).

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

minItems : 0
maxLength : 90 
aliasEmails array (string) 

그룹 보조 메일 주소 목록(그룹 메일 사용 시).

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

minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

외부 메일 수신 여부(그룹 메일 사용 시)

 
toExternalEmails array (string) 

그룹 메일을 수신할 외부 메일 주소 목록.
사내 메일 도메인의 메일 주소는 사용할 수 없음.


minItems : 0
maxItems : 500 
membersAllowedToUseGroupEmailAsRecipient array (GroupAllowedMember) 

그룹 메일 주소에 메일을 보낼 수 있는 구성원 지정(그룹 메일 사용 시).
지정된 구성원이 보낸 그룹 메일만 수신


minItems : 0 
membersAllowedToUseGroupEmailAsSender array (GroupAllowedMember) 

해당 그룹 메일 주소를 보내는 주소로 사용할 수 있는 구성원 목록(그룹 메일 사용 시).
그룹 관리자나 구성원인 경우만 지정 가능(아닌 경우 목록에서 제외됨)


minItems : 0 
dynamicMembership object (dynamicMembership) 

동적 멤버십

 

GroupAdministrator

PropertyTypeDescription
userId string 

구성원 ID
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required 

GroupMember

PropertyTypeDescription
id string 

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


required 
type string 

required
Allowed values : USER, ORGUNIT, GROUP 

GroupAllowedMember

PropertyTypeDescription
userId string 

구성원 ID
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required 

dynamicMembership

PropertyTypeDescription
query string 

멤버십 쿼리.
쿼리 작성법은 개요를 참고한다.


maxLength : 10000 
excludeUserIds array (string) 

그룹에 포함하지 않을 구성원 ID 목록, 아래 유형으로 지정 가능

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

minItems : 0 

Request Example

example

1{2  "domainId": 10000001,3  "groupName": "그룹1",4  "useServiceNotification": true,5  "serviceManageable": true,6  "groupExternalKey": "GROUP_EXT_01",7  "administrators": [8    {9      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"10    }11  ],12  "useMessage": false,13  "useNote": false,14  "useCalendar": false,15  "useFolder": false,16  "useTask": false,17  "useMail": true,18  "groupEmail": "email@example.com",19  "canReceiveExternalMail": true,20  "toExternalEmails": [21    "external@example.com"22  ],23  "membersAllowedToUseGroupEmailAsRecipient": [],24  "dynamicMembership": {25    "query": "user.levelId == levelaa7-b824-4937-66af-042f1f43cefa",26    "excludeUserIds": [27      "userf7da-f82c-4284-13e7-030f3b4c756x"28    ]29  }30}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

도메인ID


required
format : int32 
groupId string 

자동으로 부여되는 ID


readOnly : true 
groupName string 

그룹명. 도메인 내에서 유일해야 함.


required
maxLength : 100 
description string 

그룹 설명


maxLength : 300
nullable : true 
visible boolean 

그룹 공개 여부. 관리자, 구성원이 아닌 사용자의 검색 결과에도 노출할지 여부


default : true 
useServiceNotification boolean 

서비스 알림 발송 여부


default : false 
serviceManageable boolean 

그룹 관리자가 서비스 사용 여부를 변경할 수 있는지 여부


default : true 
groupExternalKey string 

그룹의 외부 키


maxLength : 100
nullable : true 
administrators array (GroupAdministrator) 

그룹의 관리자 목록


required
minItems : 1 
members array (GroupMember) 

그룹 구성원 목록


required 
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 
useMail boolean 

그룹 메일 사용 여부.

  • 네이버웍스 코어 Standard, Standard Plus 상품만 사용 가능
  • 이 값이 true이면 groupEmail 항목도 필수로 입력해야 함.

default : false 
groupEmail string 

그룹 메일 주소(그룹 메일 사용 시).

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

minItems : 0
maxLength : 90 
aliasEmails array (string) 

그룹 보조 메일 주소 목록(그룹 메일 사용 시).

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

minItems : 0
maxItems : 20 
canReceiveExternalMail boolean 

외부 메일 수신 여부(그룹 메일 사용 시).


default : false 
toExternalEmails array (string) 

그룹 메일을 수신할 외부 메일 주소 목록.
사내 메일 도메인의 메일 주소는 사용할 수 없음.


minItems : 0
maxItems : 500 
membersAllowedToUseGroupEmailAsRecipient array (GroupAllowedMember) 

그룹 메일 주소에 메일을 보낼 수 있는 구성원 지정(그룹 메일 사용 시).
지정된 구성원이 보낸 그룹 메일만 수신


minItems : 0 
membersAllowedToUseGroupEmailAsSender array (GroupAllowedMember) 

해당 그룹 메일 주소를 보내는 주소로 사용할 수 있는 구성원 목록(그룹 메일 사용 시).
그룹 관리자나 구성원인 경우만 지정 가능(아닌 경우 목록에서 제외됨)


minItems : 0 
useDynamicMembership boolean 

동적 멤버십 사용 여부

  • true로 설정 시 쿼리 조건에 따라 그룹 멤버가 자동으로 추가되거나 삭제된다.
  • 동적 멤버십을 사용할 경우 그룹 멤버가 자동으로 추가,삭제되므로 그룹 구성원으로 전달하는 members는 무시된다.

default : false 
dynamicMembership object (dynamicMembership) 

동적 멤버십

 

GroupAdministrator

PropertyTypeDescription
userExternalKey string 

구성원 외부 키


readOnly : true 
userId string 

구성원 ID
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required 

GroupMember

PropertyTypeDescription
externalKey string 

구성원 외부 키


readOnly : true 
id string 

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


required 
type string 

required
Allowed values : USER, ORGUNIT, GROUP 

GroupAllowedMember

PropertyTypeDescription
userExternalKey string 

구성원 외부 키


readOnly : true 
userId string 

구성원 ID
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required 

dynamicMembership

PropertyTypeDescription
query string 

멤버십 쿼리.
쿼리 작성법은 개요를 참고한다.


maxLength : 10000 
excludeUserIds array (string) 

그룹에 포함하지 않을 구성원 ID 목록, 아래 유형으로 지정 가능

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

minItems : 0 

Response Example

example

1{2  "domainId": 10000001,3  "groupId": "group127-8545-4463-603b-04d550d23bf",4  "groupName": "그룹1",5  "description": "도메인 그룹",6  "visible": true,7  "useServiceNotification": true,8  "serviceManageable": true,9  "groupExternalKey": "GROUP_EXT_01",10  "administrators": [11    {12      "userExternalKey": "USER_EXT_01",13      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"14    }15  ],16  "members": [17    {18      "externalKey": "USER_EXT_01",19      "id": "userf7da-f82c-4284-13e7-030f3b4c756x",20      "type": "USER"21    },22    {23      "externalKey": "ORGUNIT_EXT_01",24      "id": "orgunitf-f27f-4af8-27e1-03817a911417",25      "type": "ORGUNIT"26    },27    {28      "externalKey": "GROUP_EXT_01",29      "id": "group769-e656-477d-69c7-04e2f73a4a77",30      "type": "GROUP"31    }32  ],33  "useMessage": true,34  "useNote": true,35  "useCalendar": true,36  "useFolder": true,37  "useTask": true,38  "useMail": true,39  "groupEmail": "email@example.com",40  "aliasEmails": [41    "alias@example.com"42  ],43  "canReceiveExternalMail": true,44  "toExternalEmails": [45    "external@example.com"46  ],47  "membersAllowedToUseGroupEmailAsRecipient": [48    {49      "userExternalKey": "USER_EXT_01",50      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"51    }52  ],53  "membersAllowedToUseGroupEmailAsSender": [54    {55      "userExternalKey": "USER_EXT_01",56      "userId": "userf7da-f82c-4284-13e7-030f3b4c756x"57    }58  ],59  "useDynamicMembership": true,60  "dynamicMembership": {61    "query": "user.levelId == levelaa7-b824-4937-66af-042f1f43cefa",62    "excludeUserIds": [63      "userf7da-f82c-4284-13e7-030f3b4c756x"64    ]65  }66}

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 409

Conflict