구성원 목록 조회

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

Media Connect Center의 구성원 목록을 조회하는 API입니다.

요청

GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/users

요청 헤더

항목	필수 여부	설명
x-ncp-apigw-timestamp	Y	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Y	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Y	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-region_code	N	리전 코드 (KR) `x-ncp-region_code:KR`
Content-Type	Y	요청 Body Content Type을 application/json으로 지정 `Content-Type: application/json`

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키

요청 Query 파라미터

파라미터	타입	크기	필수 여부	설명
limit	Number		N	반환될 최대 항목 수, 기본 10
offset	Number		N	컬렉션에서 반환될 첫 번째 항목의 오프셋, 기본 0

요청 예시

GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/users?limit=2&offset=3
Host: ncloudmcc.apigw.ntruss.com
x-ncp-apigw-signature-v2: +4kkeJ+hRUcWH4xsXDQvuDEzfpqDRPr4D+Gc+GnFPHo=
x-ncp-apigw-timestamp: 1700470912198
x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
x-ncp-region_code: KR

응답

응답 Body 파라미터

파라미터	타입	크기	필수 여부	설명
page.count	Number			반환된 항목 수
page.offset	Number			반환된 첫 번째 항목의 오프셋
page.limit	Number			반환된 최대 항목 수
page.total	Number			컬렉션 내 모든 항목 수
users[].name	String	100		구성원명
users[].i18nNames	Map			구성원 다국어명 `Map<Locale, String> i18nNames`
users[].deptExternalKey	string	100		부서 외부키
users[].jobGradeExternalKey	string	100		직급 외부키
users[].jobPositionExternalKey	string	100		직책 외부키
users[].emailAddr	string	100		업무메일(login ID)
users[].telNo	string	100		전화번호
users[].cphNo	string	100		휴대전화번호
users[].localeTypeCd	string			로캘 정보
users[].tmznTypeCd	string			타임존 정보
users[].externalKey	String	36	Y	구성원 외부키

응답 예시

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Date: Mon, 20 Nov 2023 09:01:52 GMT
Server: nginx
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 68e9pckqm4c356coj1ckpjicpo

{
    "page":
    {
        "count":2,
        "offset":3,
        "limit":2,
        "total":6
    },
    "users":
    [
        {
            "name":"홍길동",
            "i18nNames":
            {
                "ko_KR": "홍길동",
                "en_US": "Hong Gil Dong"
            },            
            "deptExternalKey":"dept01",
            "jobGradeExternalKey":"jg02",
            "jobPositionExternalKey":"jp03",    
            "emailAddr":"aaa@bbb.com",
            "telNo":"KR+82 021234567",
            "cphNo":"KR+82 01012345678",
            "localeTypeCd":"ko_KR",
            "tmznTypeCd":"Asia/Seoul",
            "externalKey":"user01"
        },
        {
           "name":"김개똥",
            "i18nNames":
            {
                "ko_KR": "김개똥",
                "en_US": "Kim Gae Ddong"
            },            
            "deptExternalKey":"dept02",
            "jobGradeExternalKey":"jg02",
            "jobPositionExternalKey":"jp02",    
            "emailAddr":"aab@bbb.com",
            "telNo":"KR+82 021234567",
            "cphNo":"KR+82 01023456789",
            "localeTypeCd":"ko_KR",
            "tmznTypeCd":"Asia/Seoul",
            "externalKey":"user02"
        }
    ]
}

이 문서가 도움이 되었습니까?

What's Next

구성원 조회

요청
응답