メンバー照会

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

Media Connect Centerのメンバーを照会する APIです。

リクエスト

GET 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	メンバーの外部キー

リクエスト例

GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/users/user01
Host: ncloudmcc.apigw.ntruss.com
x-ncp-apigw-signature-v2: nOhpHMiLlhG4T43/PXwyicuo9yyNAPwx4jcWC6W/ewY=
x-ncp-apigw-timestamp: 1700462630277
x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
x-ncp-region_code: KR

レスポンス

レスポンス Bodyパラメータ

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

レスポンス例

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Date: Mon, 20 Nov 2023 06:43:50 GMT
Server: nginx
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 6cc1hc8q6ce1j68cj264sj6p9n

{
    "user":
    {
        "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",
        "externalKey":"user01"
    }
}