MENU
      Viewing members

        Viewing members


        Article summary

        Available in Classic and VPC

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

        Requests

        GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/users/{externalKey}
        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
        externalKeyString36YExternal key of the member

        Request examples

        GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/users/user01
        Host: ncloudmcc.apigw.ntruss.com
        x-ncp-apigw-signature-v2: nOhpHMiLlhG4T43/PXwyicuo9yyNAPwx4jcWC6W/ewY=
        x-ncp-apigw-timestamp: 1700462630277
        x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
        x-ncp-region_code: KR
        Plain text

        Responses

        Response body parameters

        ParametersTypeSizeRequiredDescription
        user.nameString100Member name
        user.i18nNamesMapMultilingual member name
        Map<Locale, String> i18nNames
        user.deptExternalKeystring100External key of department
        user.jobGradeExternalKeystring100External key of job grade
        user.jobPositionExternalKeystring100External key of job position
        user.emailAddrstring100Business email (login ID)
        user.telNostring100Phone number
        user.cphNostring100Mobile number
        user.localeTypeCdstringLocale information
        user.tmznTypeCdstringTimezone information
        user.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 06:43:50 GMT
        Server: nginx
        x-ncp-apigw-response-origin: ENDPOINT
        x-ncp-trace-id: 6cc1hc8q6ce1j68cj264sj6p9n
        
        {
            "user":
            {
                "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"
            }
        }
        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.