GET/directory/user-types/{userTypeId}

사용자 유형 정보를 조회한다.

참고

  • 도메인의 사용자 유형 사용 여부가 'true'로 설정되어 있어야 한다.

Authorization

oauth2

oauth2인증, 자세한 내용은 인가·인증를 참조한다

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/user-types/{userTypeId}

Path Parameters

ParameterTypeDescription
userTypeId string 

사용자 유형 리소스 ID 또는 외부 키.
외부 키는 "externalKey:{externalKey}" 형태


required
example : employ2c-f321-47a6-ac11-e81fcc23a8c3 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

사용자 유형의 도메인 ID


required
format : int32 
userTypeId string 

자동으로 부여되는 ID


readOnly : true 
displayOrder integer 

정렬 순서. 음수와 중복이 허용되며 상대 비교를 통해 오름차순으로 정렬된다.


required
format : int32 
userTypeName string 

사용자 유형명. 도메인 내에서 유일해야 한다. 특수 문자는 !@&()-_+[]{},./만 허용한다.


required
maxLength : 100 
userTypeExternalKey string 

사용자 유형 외부 키. 테넌트 내에서 유일해야 한다.
%#/? 입력 불가


maxLength : 100
nullable : true 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 
userTypeCode string 

사용자 유형 코드. 영문자(A ~ Z, a ~ z), 숫자(0 ~ 9), 밑줄 기호(_)를 포함해 최대 50자까지 지정할 수 있다. 반드시 영문자로 시작해야 한다.


maxLength : 50
nullable : true 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, zh_CN, zh_TW 

Response Example

example

1{2  "domainId": 10000001,3  "userTypeId": "employ2c-f321-47a6-ac11-e81fcc23a8c3",4  "displayOrder": 1,5  "userTypeName": "UserType Name",6  "userTypeExternalKey": "USERTYPE_EXT_01",7  "i18nNames": [8    {9      "name": "English Name",10      "language": "en_US"11    }12  ],13  "userTypeCode": "code"14}

HTTP 403

Forbidden

HTTP 404

Not Found