メンバーリストの照会

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

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

リクエスト

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

リクエストヘッダ

項目	必須有無	説明
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 > 基本設定 > 連携キー

リクエスト Queryパラメータ

パラメータ	タイプ	容量	必須有無	説明
limit	Number		N	返される最大項目数、デフォルト10
offset	Number		N	コレクションから返される最初の項目のオフセット、デフォルト0

リクエスト例

GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/users?limit=2&offset=3
Host: ncloudmcc.apigw.ntruss.com
x-ncp-apigw-signature-v2: +4kkeJ+hRUcWH4xsXDQvuDEzfpqDRPr4D+Gc+GnFPHo=
x-ncp-apigw-timestamp: 1700470912198
x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
x-ncp-region_code: KR

レスポンス

レスポンス Bodyパラメータ

パラメータ	タイプ	容量	必須有無	説明
page.count	Number			返された項目数
page.offset	Number			返された最初の項目のオフセット
page.limit	Number			返された最大項目数
page.total	Number			コレクション内の全項目数
users[].name	String	100		メンバー名
users[].i18nNames	Map			メンバーの多言語名 `Map<Locale, String> i18nNames`
users[].deptExternalKey	string	100		部署の外部キー
users[].jobGradeExternalKey	string	100		役職の外部キー
users[].jobPositionExternalKey	string	100		職位の外部キー
users[].emailAddr	string	100		業務メール(login ID)
users[].telNo	string	100		電話番号
users[].cphNo	string	100		携帯電話番号
users[].localeTypeCd	string			ロケール情報
users[].tmznTypeCd	string			タイムゾーン情報
users[].externalKey	String	36	Y	メンバーの外部キー

レスポンス例

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Date: Mon, 20 Nov 2023 09:01:52 GMT
Server: nginx
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 68e9pckqm4c356coj1ckpjicpo

{
    "page":
    {
        "count":2,
        "offset":3,
        "limit":2,
        "total":6
    },
    "users":
    [
        {
            "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"
        },
        {
           "name":"キムゲトン",
            "i18nNames":
            {
                "ko_KR": "김개똥",
                "en_US": "Kim Gae Ddong"
            },            
            "deptExternalKey":"dept02",
            "jobGradeExternalKey":"jg02",
            "jobPositionExternalKey":"jp02",    
            "emailAddr":"aab@bbb.com",
            "telNo":"KR+82 021234567",
            "cphNo":"KR+82 01023456789",
            "localeTypeCd":"ko_KR",
            "tmznTypeCd":"Asia/Seoul",
            "externalKey":"user02"
        }
    ]
}

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

What's Next

メンバー照会

リクエスト
レスポンス