Classic/VPC環境で利用できます。
メンバーの情報を更新します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| PUT | /ncloudmcc/v1/companies/{companyId}/users/{externalKey} |
リクエストヘッダ
Media Connect Center APIで共通して使用されるヘッダの詳細は、Media Connect Centerのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
companyId |
String | Required | 連携キー
|
externalKey |
String | Required | メンバーの外部キー(External Key)
|
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
name |
String | Required | メンバーの氏名 |
i18nNames |
Object | Optional | メンバーの多言語名 |
i18nNames.{locale} |
String | Optional | 言語ごとのメンバー名
|
deptExternalKey |
String | Optional | 部署の外部キー(External Key)
|
jobGradeExternalKey |
String | Optional | 役職の外部キー(External Key)
|
jobPositionExternalKey |
String | Optional | 職責の外部キー(External Key)
|
telNo |
String | Optional | 電話番号
|
cphNo |
String | Optional | 携帯電話番号
|
localeTypeCd |
String | Optional | ロケールコード
|
tmznTypeCd |
String | Optional | タイムゾーンコード
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request PUT 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/users/hg-user001' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "ホンギルドン",
"i18nNames": {
"ko_KR": "홍길동",
"en_US": "Hong Gildong"
},
"deptExternalKey": "hg-tw-cd",
"jobGradeExternalKey": "hg-grade-4",
"jobPositionExternalKey": "hg-pstn-6",
"telNo": "KR+82 0213572468",
"cphNo": "KR+82 01012345678",
"localeTypeCd": "ko_KR",
"tmznTypeCd": "Asia/Seoul"
}'
レスポンス
レスポンス形式を説明します。
レスポンスステータスコード
Media Connect Center APIで共通して使用されるレスポンスステータスコードの詳細は、Media Connect Centerのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンス成功時、200 OKと表示され、メンバー情報が更新されます。