PATCH/Groups/{groupId}
그룹 정보를 부분 수정한다.
외부 그룹 또는 동적 그룹은 수정할 수 없다.
구성원, 그룹 유형의 그룹 구성원만 추가/삭제할 수 있다. 조직 유형의 그룹 구성원은 그대로 유지한다.
SCIM Group API로 설정할 수 있는 속성만 변경된다.
SCIM Group API로 설정할 수 없는 속성(메시지방 기능, 메일링리스트, 공개여부 등)은 기존값을 유지한다.
SCIM Group API로 설정할 수 없는 속성(메시지방 기능, 메일링리스트, 공개여부 등)은 NAVER WORKS 서비스 내에서 그룹을 수정하거나 NAVER WORKS API를 사용해야 한다.
자세한 SCIM PATCH 제공 범위는 PATCH Operation을 참고한다.
주의
- 그룹 추가/수정/부분 수정/삭제 API는 동일 그룹에 대하여 동시에 호출해서는 안 되며, 순서 대로 호출해야 한다.
- Request Body의 Operations 목록 내 모든 요청이 유효한 경우에만 수정된다.
- Request Body의 Operations 목록 순서 대로 반영된다.
| Parameter | Type | Description |
|---|---|---|
| groupId | string | 그룹 ID required |
| Header | type | Description |
|---|---|---|
| Authorization | string | Bearer {token} SCIM 전용 Long-Lived Token 발급 문서를 참고한다. required |
| Content-Type | string | application/json required |
| Property | Type | Description |
|---|---|---|
| schemas | array (string) | Schema URL required |
| Operations | array (ScimPatchOperation) | 부분 수정 요청 목록 required |
| Property | Type | Description |
|---|---|---|
| op | string | required Allowed values : add, replace, remove |
| path | string | 수정할 속성 경로 또는 필터 |
| value | object | |
| array (undefined) | ||
| string | ||
| boolean | ||
| null |
Example 1
1{2 "schemas": [3 "urn:ietf:params:scim:api:messages:2.0:PatchOp"4 ],5 "Operations": [6 {7 "op": "replace",8 "path": "displayName",9 "value": "새로운 그룹명"10 },11 {12 "op": "add",13 "path": "members",14 "value": null15 }16 ]17}| Property | Type | Description |
|---|---|---|
| schemas | array (string) | Schema URL |
| id | string | 그룹 ID |
| externalId | string | SCIM 클라이언트 측에서 관리하는 ID |
| displayName | string | 그룹명 |
| members | array (ScimGroupMember) | 그룹 구성원 목록 |
| meta | object (meta) |
| Property | Type | Description |
|---|---|---|
| value | string | 그룹 구성원 ID(구성원 ID 또는 그룹 ID) required |
| type | string | 그룹 구성원 유형 Allowed values : USER, GROUP readOnly : true |
| display | string | 그룹 구성원 이름(구성원 이름 또는 그룹명) readOnly : true |
| $ref | string | 참조 URL 그룹 구성원의 상세 정보를 조회한다. readOnly : true |
| Property | Type | Description |
|---|---|---|
| resourceType | string | 리소스 유형 Allowed values : USER, GROUP |
| created | string | 생성일 |
| lastModified | string | 최근 수정일 |
| location | string | 리소스 URI |
Bad Request
Not Found
Conflict