リクエスト

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

リクエストヘッダ

項目	必須有無	説明
x-ncp-apigw-timestamp	Y	1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	Y	NAVERクラウドプラットフォームポータルで発行された Access Key ID値 `x-ncp-iam-access-key:{Sub Account Access Key}`
x-ncp-apigw-signature-v2	Y	Access Key ID値と Secret Keyで暗号化した署名 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
x-ncp-region_code	N	リージョンコード(KR) `x-ncp-region_code:KR`
Content-Type	Y	リクエスト Body Content Typeを application/jsonに指定 `Content-Type: application/json`

リクエスト Pathパラメータ

パラメータ	タイプ	容量	必須有無	説明
companyId	String	36	Y	連携キー(CompanyId) Developers > 基本設定 > 連携キー
externalKey	String	36	Y	メンバーの外部キー

リクエスト Bodyパラメータ

パラメータ	タイプ	容量	必須有無	説明
name	String	100	Y	メンバー名
i18nNames	Map		N	メンバーの多言語名 `Map<Locale, String> i18nNames`
deptExternalKey	string	100	N	部署の外部キー
jobGradeExternalKey	string	100	N	役職の外部キー
jobPositionExternalKey	string	100	N	職位の外部キー
emailAddr	string	100	Y	業務メール(login ID)
telNo	string	100	N	電話番号(ex: KR+82 0212345678) `{iso3316}{E.164} {phoneNumber}`
cphNo	string	100	N	携帯電話番号(ex: KR+82 01012345678) `{iso3316}{E.164} {phoneNumber}`
localeTypeCd	string		N	ロケール情報
tmznTypeCd	string		N	タイムゾーン情報

リクエスト例

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":"ホンギルドン",
    "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"
}

レスポンス

レスポンス例

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

この記事は役に立ちましたか?

リクエスト
レスポンス
- レスポンス例