Create member
- Print
- PDF
Create member
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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
| 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 longerx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Y | Value of access key ID issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Y | Signature encrypted with the access key ID value and secret keyx-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/jsonContent-Type: application/json |
Request path parameters
| Parameters | Type | Size | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | Integration key (CompanyId) Developers > Basic settings > Integration key |
| externalKey | String | 36 | Y | External key of the member |
Request body parameters
| Parameters | Type | Size | Required | Description |
|---|---|---|---|---|
| name | String | 100 | Y | Member name |
| i18nNames | Map | N | Multilingual member nameMap<Locale, String> i18nNames | |
| deptExternalKey | string | 100 | N | External key of department |
| jobGradeExternalKey | string | 100 | N | External key of job grade |
| jobPositionExternalKey | string | 100 | N | External key of job position |
| emailAddr | string | 100 | Y | Business email (login ID) |
| telNo | string | 100 | N | Phone number (ex: KR+82 0212345678){iso3316}{E.164} {phoneNumber} |
| cphNo | string | 100 | N | Mobile number (ex: KR+82 01012345678){iso3316}{E.164} {phoneNumber} |
| localeTypeCd | string | N | Locale information | |
| tmznTypeCd | string | N | Timezone 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?