구성원 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

구성원의 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /ncloudmcc/v1/companies/{companyId}/users/{externalKey}

요청 헤더

Media Connect Center API에서 공통으로 사용하는 헤더에 대한 정보는 Media Connect Center 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
companyId String Required 연동키
  • 콘솔에서 확인: Media Connect Center > Developers > 기본 설정 > 연동키
externalKey String Required 구성원 외부 키(External Key)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/users/hg-user001' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
user Object - 구성원 정보
user.deptExternalKey String - 부서 외부 키(External Key)
user.name String - 구성원 이름
user.i18nNames Object - 구성원 다국어 이름
user.i18nNames.{locale} String - 언어별 구성원 이름
  • "언어 코드": "값" 형태
  • 한국어, 영어, 일본어 중 등록된 값 표시
user.emailAddr String - 이메일 주소(로그인 아이디)
user.telNo String - 전화번호
  • {ISO 3166-1 국가 코드}+{E.164 국가 번호} {전화번호} 형태
user.cphNo String - 휴대전화번호
  • {ISO 3166-1 국가 코드}+{E.164 국가 번호} {전화번호} 형태
user.localeTypeCd String - 로케일 코드
user.tmznTypeCd String - 타임존 코드
user.jobPositionExternalKey String - 직책 외부 키(External Key)
user.jobGradeExternalKey String - 직급 외부 키(External Key)
user.externalKey String - 구성원 외부 키(External Key)

응답 상태 코드

Media Connect Center API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media Connect Center 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "user": {
        "deptExternalKey": "hg-tw-cd",
        "name": "홍길동",
        "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "Hong Gildong"
        },
        "emailAddr": "gdong@ncloud.com",
        "telNo": "KR+82 0213572468",
        "cphNo": "KR+82 01012345678",
        "localeTypeCd": "ko_KR",
        "tmznTypeCd": "Asia/Seoul",
        "jobPositionExternalKey": "hg-pstn-6",
        "jobGradeExternalKey": "hg-grade-6",
        "externalKey": "hg-user001"
    }
}