Viewing member list

Prev Next

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

It is an API to view the Media Connect Center members list.

Requests

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

Request headers

Item Required Description
x-ncp-apigw-timestamp Y Time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference from the API Gateway server is 5 minutes or longer
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Y Value of access key ID issued from NAVER Cloud Platform portal
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Y Signature encrypted with the access key ID value and secret key
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-region_code N Region code (KR)
x-ncp-region_code:KR
Content-Type Y Specifies the request body content type as application/json
Content-Type: application/json

Request path parameters

Parameters Type Size Required Description
companyId String 36 Y Integration key (CompanyId)
Developers > Basic settings > Integration key

Request query parameters

Parameters Type Size Required Description
limit Number N Maximum number of items to be returned, default 10
offset Number N Offset of the first item to be returned from the collection, default 0

Request examples

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

Responses

Response body parameters

Parameters Type Size Required Description
page.count Number Number of items returned
page.offset Number Offset of the first item returned
page.limit Number Maximum number of items returned
page.total Number Total number of items in the collection
users[].name String 100 Member name
users[].i18nNames Map Multilingual member name
Map<Locale, String> i18nNames
users[].deptExternalKey string 100 External key of department
users[].jobGradeExternalKey string 100 External key of job grade
users[].jobPositionExternalKey string 100 External key of job position
users[].emailAddr string 100 Business email (login ID)
users[].telNo string 100 Phone number
users[].cphNo string 100 Mobile number
users[].localeTypeCd string Locale information
users[].tmznTypeCd string Timezone information
users[].externalKey String 36 Y External key of the member

Response examples

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":"Hong Gil Dong",
            "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":"Kim Gae Ddong",
            "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"
        }
    ]
}