メンバーの作成

Prev Next

Classic/VPC環境で利用できます。

メンバーを作成します。メンバーが作成されると、そのメンバーのメールアドレス宛てに認証およびログインアカウントのパスワード設定のための招待メールが送信されます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /ncloudmcc/v1/companies/{companyId}/users/{externalKey}

リクエストヘッダ

Media Connect Center APIで共通して使用されるヘッダの詳細は、Media Connect Centerのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
companyId String Required 連携キー
  • コンソールで確認: Media Connect Center > Developers > 基本設定 > 連携キー
externalKey String Required メンバーの外部キー(External Key)
  • メンバーの識別用区切り文字

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required メンバーの氏名
i18nNames Object Optional メンバーの多言語名
i18nNames.{locale} String Optional 言語ごとのメンバー名
  • "言語コード": "値"形式で入力
  • サポートする言語コード: ko_KR | ja_JP | en_US
  • <例> "ko_KR": "홍길동""en_US": "Hong Gil Dong"
deptExternalKey String Optional 部署の外部キー(External Key)
jobGradeExternalKey String Optional 役職の外部キー(External Key)
jobPositionExternalKey String Optional 職責の外部キー(External Key)
emailAddr String Required メールアドレス(ログイン ID)
  • このメールアドレスでメンバーを作成後は変更不可
telNo String Optional 電話番号
  • {ISO 3166-1国コード}+{E.164国番号} {電話番号}形式で入力
  • <例> KR+82 0212345678
cphNo String Optional 携帯電話番号
  • {ISO 3166-1国コード}+{E.164国番号} {電話番号}形式で入力
  • <例> KR+82 01012345678
localeTypeCd String Optional ロケールコード
  • ko_KR | ja_JP | en_US
tmznTypeCd String Optional タイムゾーンコード: タイムゾーンコード

タイムゾーンコード

タイムゾーンコードは次の通りです。

コード 説明
Pacific/Midway GMT-11:00(MidwayIsland, Samoa)
Pacific/Honolulu GMT-10:00(Hawaii)
Pacific/Marquesas GMT-09:30(Marquesas)
America/Anchorage GMT-09:00(Alaska)
America/Los_Angeles GMT-08:00(PacificTime)
America/Denver GMT-07:00(MountainTime_US/Canada)
America/Chicago GMT-06:00(CentralTime_US/Canada)
America/New_York GMT-05:00(EasternTime_US/Canada)
America/Caracas GMT-04:30(Caracas)
America/Santiago GMT-04:00(Santiago)
America/St_Johns GMT-03:30(Newfoundland)
America/Sao_Paulo GMT-03:00(SaoPaulo)
America/Noronha GMT-02:00(Mid-Atlantic)
Atlantic/Azores GMT-01:00(Azores)
Europe/London GMT+00:00(GreenwichMeanTime_London)
Europe/Berlin GMT+01:00(Amsterdam,Berlin, Vienna)
Europe/Athens GMT+02:00(Athens, Cairo)
Asia/Baghdad GMT+03:00(Moscow, Baghdad)
Asia/Tehran GMT+03:30(Tehran)
Asia/Baku GMT+04:00(Baku, Muscat)
Asia/Karachi GMT+05:00(Karachi)
Asia/Colombo GMT+05:30(NewDelhi,Mumbai, Colombo)
Asia/Katmandu GMT+05:45(Katmandu)
Asia/Dhaka GMT+06:00(Astana, Dhaka)
Asia/Rangoon GMT+06:30(Rangoon)
Asia/Bangkok GMT+07:00(Bangkok, Hanoi,Jakarta)
Asia/Shanghai GMT+08:00(Beijing,Dalian, Singapore, Taiwan)
Asia/Seoul GMT+09:00(Seoul)
Asia/Tokyo GMT+09:00(Tokyo, Fukuoka)
Australia/Darwin GMT+09:30(Darwin,Adelaide)
Australia/Sydney GMT+10:00(Guam,Canberra, Sydney)
Australia/Lord_Howe GMT+10:30(LordHoweIsland)
Pacific/Noumea GMT+11:00(NewCaledonia)
Pacific/Norfolk GMT+11:30(NorfolkIsland)
Pacific/Auckland GMT+12:00(Auckland,Fiji)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST '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 Gil Dong"
    },
    "deptExternalKey": "hg-tw-cd",
    "jobGradeExternalKey": "hg-grade-4",
    "jobPositionExternalKey": "hg-pstn-6",
    "emailAddr": "gdong@ncloud.com",
    "telNo": "KR+82 021234567",
    "cphNo": "KR+82 01012345678",
    "localeTypeCd": "ko_KR",
    "tmznTypeCd": "Asia/Seoul"
}'

レスポンス

レスポンス形式を説明します。

レスポンスステータスコード

Media Connect Center APIで共通して使用されるレスポンスステータスコードの詳細は、Media Connect Centerのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンス成功時、201 Createdと表示され、メンバーが作成されます。