Workspace MDM API

Overview

本APIはWorkspace MDMにおけるリモートロック＆リモートワイプを利用するAPIです。
ご利用いただくためには「Workspace MDM」のご契約が必要となります。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/workspace-mdm

2.Base Path(Region)

https://{region}.api.ntt.com/v1/workspace-mdm

• region is jp|us|uk
• e.g. https://us.api.ntt.com/v1/cloudn/compute
• 指定できるregionは、将来拡充予定

Resource Information

テナント認証ヘッダの追加

テナントログイン用に以下のHTTP Headerをすべてのリクエストに追加してください。

呼び出し上限

API呼び出しに伴い、MDMサーバーに負荷がかかることでシステムが不安定となるため、不用意な呼び出しは控えてください。
最大呼び出し回数30回／分、平均呼び出し回数10回/分以下を目安としてください。

制限事項

正常系および準正常系でAPIのレスポンスが500 Internal Server Errorとなるような、サポートされていないパラメータをAPIに渡さないでください。

　ユーザ情報取得

GET /v1/workspace-mdm/account/status

ログイン中のユーザのユーザ情報を取得します。

Request Parameters

なし

Example Request

GET /v1/workspace-mdm/account/status

Response Parameters

Example Result

{
  email: 'xxxx@xxxxxxxx.com',
  name: 'name',
  phonetic_name: '名前',
  user_id: 'name',
  language: null,
  time_zone: 'Tokyo',
  guid: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
  permitted_features: [],
  company:
  {
    code: 'company_code',
    name: '利用企業名',
    guid: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    type: 'Customer'
  }
}

　機器一覧取得

GET /v1/workspace-mdm/companies/{company.guid}/assets

機器一覧を取得します。

Request Parameters

URL Path Parameter

URL Query Parameter

Example Request

GET /v1/workspace-mdm/companies/xxxxxxxxxxxxxxxxx/assets?per=20&page=1&sort=xxxxxx&order=asc

Response Parameters

Example Result

{
  pagination: {
    type: 'array',
    per: '20',
    page: '1',
    total: '2'
  },
  assets: [
      {
        'icon-url': 'https://ac-test.sys.apigw.net/app/assets/object/asset/windows/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.gif',
        guid: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        name: 'xxxxxxxxxx',
        'os-type': 'windows',
        apps: [Object] 
      },
      {
        'icon-url': 'https://ac-test.sys.apigw.net/app/assets/object/asset/windows/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.gif',
        guid: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
        name: 'xxxxxxxxxx',
        'os-type': 'windows',
        apps: [Object] 
      }
    ]
}

　コマンド送信

POST /v1/workspace-mdm/companies/{company.guid}/assets/{asset.guid}/command/{type}

機器に送信するコマンドを設定する

Request Parameters

URL Path Parameter

Body json Parameter

Example Request

POST /v1/workspace-mdm/companies/xxxxxxxxxxxxxxxxxxxxx/assets/xxxxxxxxxxxxxxxxxxx/command/lock
{
    command: {
        message: '端末をロックしました。',
        allow_unlock_code: false,
        wipe_sd_card: false
    }
}

Response Parameters

成功すると「201 Created」のステータスコードを返します。

Example Result

HTTP/1.1 201 Created