MENU
      Viewing member list

        Viewing member list


        Article summary

        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
        Plain text

        Request headers

        ItemRequiredDescription
        x-ncp-apigw-timestampYTime 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-keyYValue of access key ID issued from NAVER Cloud Platform portal
        x-ncp-iam-access-key:{Sub Account Access Key}
        x-ncp-apigw-signature-v2YSignature encrypted with the access key ID value and secret key
        x-ncp-apigw-signature-v2:{API Gateway Signature}
        x-ncp-region_codeNRegion code (KR)
        x-ncp-region_code:KR
        Content-TypeYSpecifies the request body content type as application/json
        Content-Type: application/json

        Request path parameters

        ParametersTypeSizeRequiredDescription
        companyIdString36YIntegration key (CompanyId)
        Developers > Basic settings > Integration key

        Request query parameters

        ParametersTypeSizeRequiredDescription
        limitNumberNMaximum number of items to be returned, default 10
        offsetNumberNOffset 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
        Plain text

        Responses

        Response body parameters

        ParametersTypeSizeRequiredDescription
        page.countNumberNumber of items returned
        page.offsetNumberOffset of the first item returned
        page.limitNumberMaximum number of items returned
        page.totalNumberTotal number of items in the collection
        users[].nameString100Member name
        users[].i18nNamesMapMultilingual member name
        Map<Locale, String> i18nNames
        users[].deptExternalKeystring100External key of department
        users[].jobGradeExternalKeystring100External key of job grade
        users[].jobPositionExternalKeystring100External key of job position
        users[].emailAddrstring100Business email (login ID)
        users[].telNostring100Phone number
        users[].cphNostring100Mobile number
        users[].localeTypeCdstringLocale information
        users[].tmznTypeCdstringTimezone information
        users[].externalKeyString36YExternal 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"
                }
            ]
        }
        Plain text

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.