GET/Users

구성원 목록을 조회한다.

HTTP Request

GEThttps://www.worksapis.com/scim/v2/Users

Query Parameters

ParameterTypeDescription
startIndex integer 

Offset


default : 1
minLength : 1
minimum : 1
format : int32 
count integer 

조회 개수


default : 100
minLength : 0
maxLength : 100
minimum : 0
maximum : 100
format : int32 
filter string 

필터.
userName 속성의 eq 비교만 할 수 있다.


example : userName eq "user@test.com" 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

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


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

스키마 URL

 
totalResults integer 

전체 개수

 
startIndex integer 

오프셋

 
itemsPerPage integer 

조회된 리소스 개수

 
Resources array (ScimUserResponse) 

구성원 정보

 

ScimUserResponse

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