GET/users/{userId}

구성원의 프로필 정보를 조회한다.

  • 이 API는 반드시 user.profile.read scope을 포함한 Access Token으로 호출해야 한다.
  • user / user.read scope를 포함한 Access Token으로 호출시 구성원 정보를 조회한다.

주의
조회할 수 있는 속성은 NAVER WORKS Admin에 설정된 구성원 속성에 따라 달라진다.

Authorization

oauth2

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

Scope

user.profile.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}

Path Parameters

ParameterTypeDescription
userId string 

구성원 ID
- 메일
- 리소스 ID
- 외부 키 "externalKey:{externalKey}" 형태


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userId string 

구성원 ID

 
userExternalKey string 

고객사에서 관리하는 구성원 외부 키

%, \, #, /, ?는 포함할 수 없다.


maxLength : 100
nullable : true 
email string 

계정

  • 메일 주소와 동일(Lite 상품인 경우 id@group)

maxLength : 90 
userName object (userName) 

이름 정보

 
i18nNames array (Useri18nName) 

다국어 이름 목록


minItems : 0 
organizations array (UserOrganization) 

구성원이 소속된 도메인(회사) 목록
원직과 겸직을 모두 포함한다.


minItems : 0 
telephone string 

전화번호


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

휴대폰 번호


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

근무처


maxLength : 100
nullable : true 

userName

PropertyTypeDescription
lastName string 

성


maxLength : 80
nullable : true 
firstName string 

이름


maxLength : 80
nullable : true 
phoneticLastName string 

후리가나 성


maxLength : 100
nullable : true 
phoneticFirstName string 

후리가나 이름


maxLength : 100
nullable : true 

Useri18nName

PropertyTypeDescription
language string 

다국어 언어 코드


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

다국어 이름
조직도 다국어 이름 중 뒤쪽에 노출된다.


maxLength : 100
nullable : true 
lastName string 

다국어 성
조직도 다국어 이름 중 앞쪽에 노출된다.


maxLength : 100
nullable : true 

UserOrganization

PropertyTypeDescription
domainId integer 

도메인 ID


format : int32 
userExternalKey string 

주의

  • organizations[].userExternalKey 대신 최상위 userExternalKey 값을 참조한다.

고객사에서 관리하는 구성원 외부 키

  • %, \, #, /, ?는 포함할 수 없다.

maxLength : 100
readOnly : true
nullable : true 
primary boolean 

대표 도메인 여부

 
email string 

메일 주소


maxLength : 90 
levelId string 

직급 ID


nullable : true 
levelExternalKey string 

고객사에서 관리하는 직급 외부 키


maxLength : 100
nullable : true 
levelName string 

직급 이름


nullable : true 
executive boolean 

임원 여부

 
organizationName string 

회사 이름

 
orgUnits array (object) 

조직 목록


minItems : 0
maxItems : 30 

object

PropertyTypeDescription
orgUnitId string 

조직 ID

 
orgUnitExternalKey string 

고객사에서 관리하는 조직 외부 키


maxLength : 100
nullable : true 
orgUnitName string 

조직 이름

 
orgUnitEmail string 

조직 메일 주소

 
primary boolean 

대표 조직 여부

 
positionId string 

직책 ID


nullable : true 
positionExternalKey string 

고객사에서 관리하는 직책 외부 키


maxLength : 100
nullable : true 
positionName string 

직책 이름


nullable : true 
isManager boolean 

조직장 여부


default : false 
visible boolean 

구성원 공개 여부 조직도에서 조직의 구성원으로 표시할지 여부를 나타낸다.


default : true 
useTeamFeature boolean 

조직 기능 사용 여부(기본값: true)
조직의 구성원이긴 하나 조직 메시지방에서의 메시지 수신, 파일 공유나 조직 메일 수신과 같은 보안상 중요한 기능을 제한을 위한 설정이다.
이 값이 true이면 다음과 같이 조직의 메시지방 기능을 사용할 수 있다.
조직 메시지방(Message/Note/Calendar/Folder)의 구성원으로 참여하여 메시지를 주고 받거나, 노트를 조회하고, 일정을 공유받고, 폴더를 조회할 수 있다.

  • 조직으로 보낸 메일 수신 가능
  • 조직을 대상으로 초대한 일정을 공유받음
  • 조직 캘린더 조회 가능
  • 조직으로 공유한 드라이브의 파일 조회 가능
  • 조직으로 권한을 부여한 게시판 조회 가능
  • 조직을 대상으로 한 설문에 응답 가능
  • 조직을 그룹의 구성원으로 설정한 경우 그룹의 구성원에 포함 이 값이 false이면 조직에 제공되는 위와 같은 모든 조직 기능을 사용할 수 없다.

default : true 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "userExternalKey": null,4  "email": "localpart@example.com",5  "telephone": "031-1234-5678",6  "cellPhone": "010-1234-5678",7  "location": "green building",8  "userName": {9    "lastName": "last",10    "firstName": "first",11    "phoneticLastName": null,12    "phoneticFirstName": null13  },14  "i18nName": [],15  "organizations": [16    {17      "domainId": 10000001,18      "primary": true,19      "userExternalKey": null,20      "email": "localpart@example.com",21      "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",22      "levelExternalKey": null,23      "levelName": "level",24      "executive": false,25      "organizationName": "org",26      "orgUnits": [27        {28          "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",29          "orgUnitExternalKey": null,30          "orgUnitEmail": "team01@example.com",31          "orgUnitName": "orgUnit1",32          "primary": true,33          "positionId": "position-7027-4a02-b838-6f52b5e38db7",34          "positionExternalKey": null,35          "positionName": "position",36          "isManager": true,37          "visible": true,38          "useTeamFeature": true39        }40      ]41    }42  ]43}

HTTP 404

Not Found