GET/directory/users/custom-properties/{customPropertyId}

도메인의 구성원 커스텀 속성을 조회한다.

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/users/custom-properties/{customPropertyId}

Path Parameters

ParameterTypeDescription
customPropertyId string 

customPropertyId 또는 propertyName


required
example : customfd-fc09-4a57-ab38-03dc6c425e09 

Query Parameters

ParameterTypeDescription
domainId integer 

도메인 ID


example : 10000001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

도메인 ID


required
format : int32 
customPropertyId string 

커스텀 속성 ID. 자동으로 부여되는 값


readOnly : true 
propertyName string 

커스텀 속성명
도메인 내에서 유일해야 한다. 알파벳과 숫자, 밑줄(_)만 허용한다. 알파벳 또는 밑줄(_)로 시작한다.


required
maxLength : 120 
displayName string 

커스텀 속성 표시명
도메인 내에서 유일해야 한다.


required
maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

커스텀 속성 표시명 다국어 이름 목록


minItems : 0 
propertyType string 

커스텀 속성 타입

  • STRING: 텍스트
  • LINK: 하이퍼링크
  • INTEGER: 숫자
  • DATE: 날짜

required
Allowed values : STRING, LINK, INTEGER, DATE 
displayOrder integer 

정렬 순서 중복이 허용되며 상대 비교를 통해 오름차순으로 정렬된다. 값을 입력하지 않으면(NULL) 마지막 위치로 지정된다.


required
minimum : 1
format : int32
nullable : true 
multiValued boolean 

동일 커스텀 속성을 여러 건 등록할 수 있는지 여부.


required
default : false 
options array (UserCustomPropertyOption) 

propertyType 이 STRING일 때 옵션 목록


minItems : 2 
mandatory boolean 

필수 여부


required
default : false 
readAccessType string 

읽기 가능 타입


required
default : ALL
Allowed values : ADMIN_AND_SELF, ALL 
writeAccessType string 

수정 가능 타입


required
default : ADMIN
Allowed values : ADMIN, ADMIN_AND_SELF 

I18nDisplayName

PropertyTypeDescription
language string 

다국어 언어 코드


Allowed values : ko_KR, ja_JP, zh_CN, zh_TW, en_US 
name string 

다국어 이름


maxLength : 20 

UserCustomPropertyOption

PropertyTypeDescription
optionName string 

옵션명
알파벳과 숫자, 밑줄(_)만 허용한다.


maxLength : 100 
displayName string 

옵션 표시명


maxLength : 20 
i18nDisplayNames array (I18nDisplayName) 

옵션 표시명 다국어 이름 목록


minItems : 0 

Response Example

example

1{2  "domainId": 10000001,3  "customPropertyId": "customfd-fc09-4a57-ab38-03dc6c425e01",4  "propertyName": "string_single_option",5  "displayName": "취미",6  "i18nDisplayNames": [7    {8      "language": "ko_KR",9      "name": "취미"10    },11    {12      "language": "en_US",13      "name": "hobby"14    }15  ],16  "propertyType": "STRING",17  "displayOrder": 1,18  "multiValued": false,19  "options": [20    {21      "optionName": "option_piano",22      "displayName": "피아노"23    },24    {25      "optionName": "option_cooking",26      "displayName": "요리"27    }28  ],29  "mandatory": false,30  "readAccessType": "ALL",31  "writeAccessType": "ADMIN_AND_SELF"32}

HTTP 404

Not Found