PATCH/Users/{userId}

구성원 정보를 부분 수정한다.

SCIM User API로 설정할 수 있는 속성만 변경된다.
SCIM User API로 설정할 수 없는 속성(소속 조직, 직급, 직책, 공개여부 등)은 기존값을 유지한다.
SCIM User API로 설정할 수 없는 속성(소속 조직, 직급, 직책, 공개여부 등)은 Admin Console 또는 NAVER WORKS API를 사용하여 변경할 수 있다.

자세한 SCIM PATCH 제공 범위는 PATCH Operation을 참고한다.

주의

  • 구성원 추가/수정/부분 수정/비활성화 API는 동일 구성원에 대하여 동시에 호출해서는 안 되며, 순서 대로 호출해야 한다.
  • <항목관리> 설정에 따라 각 속성의 필수 여부, 수정 가능 여부가 달라질 수 있다.
  • Request Body의 Operations 목록 내 모든 요청이 유효한 경우에만 수정된다.
  • Request Body의 Operations 목록 순서 대로 반영된다.

HTTP Request

PATCHhttps://www.worksapis.com/scim/v2/Users/{userId}

Path Parameters

ParameterTypeDescription
userId integer 

구성원 ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

SCIM 전용 Long-Lived Token 발급 문서를 참고한다.


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
schemas array (string) 

스키마 URL


required 
Operations array (ScimPatchOperation) 

부분 수정 요청 목록


required 

ScimPatchOperation

PropertyTypeDescription
op string 

required
Allowed values : add, replace, remove 
path string 

수정할 속성 경로 또는 필터

 
value object 
 
array (undefined) 
 
string 
 
boolean 
 
null 
 

Request Example

Example 1

1{2  "schemas": [3    "urn:ietf:params:scim:api:messages:2.0:PatchOp"4  ],5  "Operations": [6    {7      "op": "add",8      "path": "nickName",9      "value": "nickName"10    },11    {12      "op": "replace",13      "path": "name.givenName",14      "value": "john"15    },16    {17      "op": "remove",18      "path": "phoneNumbers[type eq \"mobile\"]"19    },20    {21      "op": "replace",22      "path": "active",23      "value": false24    },25    {26      "op": "add",27      "path": "phoneNumbers[type eq \"mobile\"].value",28      "value": "010-1234-5678"29    },30    {31      "op": "replace",32      "path": "emails[type eq \"alias\" and value eq \"alias_email_1@example.com\"]",33      "value": {34        "type": "alias",35        "primary": false,36        "value": "alias_email_2@example.com"37      }38    }39  ]40}

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

스키마 URL


required 
id string 

구성원 ID


readOnly : true 
externalId string 

SCIM 클라이언트 측에서 관리하는 ID


maxLength : 100 
userName string 

계정. 메일 주소와 동일하다.

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

required
maxLength : 90 
name object (name) 

required 
displayName string 

표시 이름


readOnly : true 
nickName string 

닉네임

  • 특수 문자는 ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~만 허용한다.

maxLength : 100 
preferredLanguage string 

언어 코드


Allowed values : ko-KR, ja-JP, en-US, zh-CN, zh-TW 
timezone string 

타임존


default : 도메인에 설정된 타임존 
active boolean 

활성화 여부

  • true: 사용 중
  • false: 일시 정지

구성원 추가 시 반드시 true로 전달해야 한다.


default : true 
emails array (ScimUserEmail) 

이메일 정보

 
phoneNumbers array (ScimUserPhoneNumber) 

전화번호 정보

 
ims array (ScimUserInstantMessage) 

메신저 정보

 
urn:ietf:params:scim:schemas:extension:works:2.0:User object (urn:ietf:params:scim:schemas:extension:works:2.0:User) 
 
meta object (meta) 
 

name

PropertyTypeDescription
familyName stringnull 

성

  • 성, 이름을 합쳐 80자까지 허용한다.
  • 성과 이름 중 하나는 반드시 입력해야 한다.
  • 특수 문자는 ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~만 허용한다.

maxLength : 80 
givenName stringnull 

이름

  • 성, 이름을 합쳐 80자까지 허용한다.
  • 성과 이름 중 하나는 반드시 입력해야 한다.
  • 특수 문자는 ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~만 허용한다.

maxLength : 80 

ScimUserEmail

PropertyTypeDescription
type string 

이메일 유형

  • alias: 보조 이메일
  • other: 개인 이메일

required
Allowed values : alias, other 
primary boolean 

대표 여부


default : false 
value string 

이메일

  • alias(보조 이메일)
    • 최대 90자
    • localpart@domain 형식
    • localpart는 영문 또는 숫자로 시작해야 한다.
    • 점(.)은 localpart의 시작과 끝에 사용할 수 없으며, 연속된 형태(..)로도 사용할 수 없다.
    • localpart는 2~40자의 영문, 숫자, 점(.), 하이픈(-), 밑줄(_)을 허용한다.
    • 최대 10개까지 설정할 수 있다.
  • other(개인 이메일)
    • SSO를 사용하지 않는 경우 필수
    • localpart@domain 형식
    • localpart는 64자 이하여야 한다.
    • domain은 253자 이하여야 한다.

required 

ScimUserPhoneNumber

PropertyTypeDescription
type string 

전화번호 유형

  • work: 사내번호
  • mobile: 휴대폰 번호

required
Allowed values : work, mobile 
primary boolean 

대표 여부


default : false 
value string 

전화번호


required
maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100} 

ScimUserInstantMessage

PropertyTypeDescription
type string 

메신저 유형


required
Allowed values : work 
primary boolean 

대표 여부


default : false 
value string 

메신저 ID


required
minLength : 1
maxLength : 100 

urn:ietf:params:scim:schemas:extension:works:2.0:User

PropertyTypeDescription
userExternalKey stringnull 

구성원 외부 키.

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


maxLength : 100 

meta

PropertyTypeDescription
resourceType string 

리소스 유형


Allowed values : USER, GROUP 
created string 

생성일

 
lastModified string 

최근 수정일

 
location string 

리소스 URI

 

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict