Create member
    • PDF

    Create member

    • PDF

    Article summary

    Available in Classic and VPC

    It is an API to create members in the Media Connect Center. Customers can add the members' information of their client companies through this API.

    Requests

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

    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 body parameters

    ParametersTypeSizeRequiredDescription
    nameString100YMember name
    i18nNamesMapNMultilingual member name
    Map<Locale, String> i18nNames
    deptExternalKeystring100NExternal key of department
    jobGradeExternalKeystring100NExternal key of job grade
    jobPositionExternalKeystring100NExternal key of job position
    emailAddrstring100YBusiness email (login ID)
    telNostring100NPhone number (ex: KR+82 0212345678)
    {iso3316}{E.164} {phoneNumber}
    cphNostring100NMobile number (ex: KR+82 01012345678)
    {iso3316}{E.164} {phoneNumber}
    localeTypeCdstringNLocale information
    tmznTypeCdstringNTimezone information

    Request examples

    POST /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/users/user01
    Host: ncloudmcc.apigw.ntruss.com
    Content-Type: application/json
    x-ncp-apigw-signature-V2: yaJreXdymUbNIxAltcWUju4/VaUn3JP3rqqzglT4KZs=
    x-ncp-apigw-timestamp: 1700457005026
    x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
    x-ncp-region_code: KR
    
    {
        "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"
    }
    

    Responses

    Response examples

    HTTP/1.1 201 Created
    Content-Length: 0
    Connection: keep-alive
    Date: Mon, 20 Nov 2023 04:41:35 GMT
    Server: nginx
    x-ncp-apigw-response-origin: ENDPOINT
    x-ncp-trace-id: 6aeb16oqj2e353gp9p6dh68d1m
    

    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.