구성원 조회

    한 명의 구성원을 조회한다.

    API 종류

    서버 API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}

    HTTP Method

    GET

    Path Parameters

    파라미터 타입 크기 필수 여부 설명
    domainId Integer Y 도메인 ID
    externalKey String 100자 Y 고객사에서 관리하는 구성원 외부 키

    Request Example

    GET https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123
    

    Response

    겸직 조회 시 원직이 반환되며, 겸직은 organizations 필드에서 확인할 수 있다.

    속성 타입 설명
    tenantId Integer 테넌트 ID
    domainId Integer 도메인 ID
    externalKey String 구성원 외부 키
    master Boolean 관리자 여부
    manager Boolean 부관리자 여부
    suspended Boolean 일시 정지 여부
    suspensionReason String 일시 정지 사유
    - MASTER: 관리자에 의한 일시 정지
    - LOGIN_FAIL: 로그인 실패
    absence Boolean 부재 여부
    absenceReason String 부재 사유
    ● BUSINESS_TRIP: 출장
    ● EDUCATION: 교육
    ● SICK_LEAVE: 병가
    ● VACATION: 휴가
    ● LEAVE_OF_ABSENCE: 휴직
    ● ETC: 기타
    resigned Boolean 삭제 여부
    standby Boolean 대기중 여부
    email String 계정.
    Basic/Premium 상품인 경우 이메일 주소와 동일.
    Lite 상품인 경우 id@group명.
    name Object
    name.lastName String
    name.firstName String 이름
    name.phoneticLastName String 후리가나 성
    name.phoneticFirstName String 후리가나 이름
    i18nNames[].language String 다국어 언어 코드.
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].firstName String 다국어 이름
    i18nNames[].lastName String 다국어 성
    nickName String 닉네임
    privateEmail String 개인 이메일 주소
    aliasEmails List<String> 보조 이메일 주소 목록
    telephone String 전화번호
    cellphone String 핸드폰 번호
    fax String 팩스 번호
    employmentTypeExternalKey String 고용 형태 외부 키
    location String 근무처
    task String 업무
    messenger Object
    messenger.protocol String 메신저 프로토콜.
    ● LINE: 라인
    ● FACEBOOK: 페이스북
    ● TWITTER: 트위터
    ● OTHER: 기타
    ● CUSTOM: 사용자 지정 프로토콜
    messenger.customProtocol String 메신저 프로토콜이 CUSTOM일 경우 사용자가 지정한 프로토콜
    messenger.messengerId String 메신저 아이디
    birthdayCalendarType String 생일 양력/음력 구분.
    ● S: 양력
    ● L: 음력
    birthday String 생일(yyyy.mm.dd)
    hireDate String 입사일(yyyy.mm.dd)
    searchable Boolean 구성원 자동 완성 및 검색 가능 여부
    organizations[] List 구성원이 소속된 도메인(회사) 목록(원직, 겸직 모두 포함)
    organizations[].domainId Integer 도메인 ID
    organizations[].levelExternalKey String 도메인 내 구성원의 직급 외부 키
    organizations[].represent Boolean 대표 도메인 여부
    organizations[].externalKey String 도메인 내 구성원 외부 키
    organizations[].email String 도메인 내 구성원 계정.
    Basic/Premium 상품인 경우 이메일 주소와 동일.
    Lite 상품인 경우 id@group명.
    organizations[].orgUnits[] List 도메인 내 구성원이 소속된 조직 목록
    organizations[].orgUnits[].domainId Integer 조직의 도메인 ID
    organizations[].orgUnits[].externalKey String 조직의 외부 키
    organizations[].orgUnits[].represent Boolean 대표 조직 여부
    organizations[].orgUnits[].positionExternalKey String 직책 외부 키
    organizations[].orgUnits[].manager Boolean 조직장 여부
    organizations[].orgUnits[].display Boolean 조직에 구성원 공개 여부
    organizations[].orgUnits[].receiveEmail Boolean 팀 기능 사용 여부.
    ● 조직의 멤버이긴 하나 팀룸에서의 메시지 수신, 파일 공유나 조직 메일 수신과 같은 보안상 중요한 팀 기능을 제한하고자 할 때 이 파라미터를 이용한다.
    ● 이 값이 true이면 다음과 같이 조직의 팀 기능을 사용할 수 있다.
    - 팀룸(Message/Note/Calendar/Folder)의 멤버로 참여하여 메시지를 주고 받거나, 노트를 조회하고, 일정을 공유받고, 폴더를 조회할 수 있음
    - 조직으로 보낸 메일 수신 가능
    - 조직을 대상으로 초대한 일정을 공유받음
    - 조직 캘린더 조회 가능
    - 조직으로 공유한 드라이브의 파일 조회 가능
    - 조직으로 권한을 부여한 게시판 조회 가능
    - 조직을 대상으로 한 설문에 응답 가능
    - 조직을 그룹의 멤버로 설정한 경우 그룹의 멤버에 포함
    ● 이 값이 false이면 조직에 제공되는 위와 같은 모든 팀 기능을 사용할 수 없다.
    relations[].relationName String 연결된 연락처의 관계 이름
    relations[].externalKey String 연결된 연락처의 구성원 외부 키
    locale String 다국어 언어 코드.
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    timeZone String 타임존 코드.
    ●Pacific/Midway
    ●Pacific/Honolulu
    ●Pacific/Marquesas
    ●America/Anchorage
    ●America/Los_Angeles
    ●America/Denver
    ●America/Chicago
    ●America/New_York
    ●America/Caracas
    ●America/Santiago
    ●America/St_John
    ●America/Sao_Paulo
    ●America/Noronha
    ●Atlantic/Azores
    ●Europe/London
    ●Europe/Berlin
    ●Europe/Athens
    ●Asia/Baghdad
    ●Asia/Tehran
    ●Asia/Baku
    ●Asia/Karachi
    ●Asia/Colombo
    ●Asia/Katmandu
    ●Asia/Dhaka
    ●Asia/Rangoon
    ●Asia/Bangkok
    ●Asia/Shanghai
    ●Asia/Seoul
    ●Asia/Tokyo
    ●Australia/Darwin
    ●Australia/Sydney
    ●Australia/Lord_Howe
    ●Pacific/Noumea
    ●Pacific/Norfolk
    ●Pacific/Auckland
    customField Object 사용자 지정 필드
    customField.{schemaKey}[] List 원직 도메인에 정의한 사용자 지정 필드 정의 키(schemaKey)
    customField.{schemaKey}[].value String 사용자 지정 필드의 노출 텍스트
    customField.{schemaKey}[].link String 사용자 지정 필드의 유형이 link일 때 URL

    Response Example

    {
      "tenantId": 1,
      "domainId": 1,
      "externalKey": "EX123",
      "master": false,
      "manager": false,
      "absence": false,
      "resigned": false,
      "standby": false,
      "email": "localpart@domain.com",
      "name": {
        "lastName": "lastName",
        "firstName": "firstName",
        "phoneticLastName": "",
        "phoneticFirstName": ""
      },
      "i18nNames": [
        {
          "language": "en_US",
          "firstName": "firstName",
          "lastName": "lastName"
        },
        {
          "firstName": "firstName",
          "lastName": "lastName"
        }
      ],
      "nickName": "nickName",
      "privateEmail": "private@domain.com",
      "aliasEmails": [
        "alias@domain.com"
      ],
      "telePhone": "000000000",
      "location": "worksPlace",
      "task": "task",
      "messenger": {
        "protocol": "LINE",
        "messengerId": "messenger"
      },
      "birthdayCalendarType": "S",
      "birthday": "2015.04.01",
      "hireDate": "2015.04.01",
      "searchable": true,
      "organizations": [
        {
          "domainId": 1,
          "primary": true,
          "externalKey": "EX123",
          "email": "localpart@domain.com",
          "orgUnits": [
            {
              "domainId": 1,
              "externalKey": "PST123",
              "primary": true,
              "manager": true,
              "display": true,
              "receiveEmail": true
            }
          ]
        }
      ],
      "relations": [],
      "locale": "ja_JP",
      "timeZone": "Asia/Seoul",
      "customField": {
        "schema123": [
          {
            "value": "Homepage1",
            "link": "https://www.unicef.org"
          },
          {
            "value": "Homepage2"
          },
          {
            "link": "https://wfuna.org"
          }
        ],
        "schema456": [
          {
            "value": "크래프톤타워"
          },
          {
            "value": "그린팩토리"
          }
        ]
      }
    }
    

    Error Code

    호출에 실패하면 오류 코드와 오류 메시지를 반환한다.
    오류 코드는 조직 연동 REST API 오류 코드를 참고한다.