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

key value
レスポンスフォーマット JSON
認証(OAuth) Yes

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

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

header value
X-Auth-Company 企業コード
X-Auth-Login ユーザID
X-Auth-Password パスワード

呼び出し上限

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

Name Description
language 個人設定で設定された言語が返される。この言語に応 じて、表示する言語を切り替える。『ブラウザーの設定を使用する』の設定になっている場合 null が返される。
time_zone 個人設定で設定されたタイムゾーンが返される。この 値に応じて、管理サイトの表示時間を切り替える。
permitted_feature ログイン中のユーザーが利用できるフィーチャーの一覧が 配列で返される。
company_code 企業コード
company_name 企業名
company_guid 企業 GUID
company_type 企業の種類
"Provider" : SP 企業
"Customer" : 利用企業

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

Name Description Type Mandatory
company.guid 企業 GUID(ユーザ情報取得で取得した値) string True

URL Query Parameter

Name Description Type Mandatory Default value
par 返却数。上限は 100 である。 number false 20
page ページ番号 number false 1
sort ソート対象。次の値を指定できる。
"asset_name" 機器名
string false 機器名
order ソート順序。
"asc" 昇順
"desc" 降順
string false asc
target 検索対象。次の値を指定できる。
"asset_name" 機器名
"model" モデル名
"phone_number" 電話番号
"imei" IMEI "serial_numbe" シリアル番号
"user_name" ユーザー名
"agent_guid" エージェント GUID
※機器 GUID とは異 なる)
string false Empty
q 検索対象の文字列。 string false Empty
custom_guid 機器カスタム項目(自由入力)の GUID
" 同一の custom_guid は 1 つのみ指定できる。
string false Empty
custom_value 機器カスタム項目(自由入力)の値 string false Empty
group_guid グループの GUID
ユーザー分類又は機器カスタム項目(分類)のグループが指定 できる。
"+" 区切りで複数個指定することができる。
その場合、同じユーザー分類又は機器カスタム項目(分類)で あれば or 条件となる。
異なるユーザー分類又は機器カスタム項目(分類)であれば、and 条件となる。
"(未分類)"である物を検索する場合、"ocategory_guid" を指定する。
string false Empty
category_guid ユーザー分類又は機器カスタム項目(分類)のGUID
ユーザー分類又は機器カスタム項目(分類)を指定できる。
ここで指定したユーザー分類又は機器カスタム項目(分類)が "(未分類)"である物を検索する。
string false Empty
os_type OS 種別を指定。
"windows" Windows 端末
"ios" iOS 端末
"mac" MacOS 端末
"android" Android 端末
※"+" 記号で接続し複数指定することができる。その場合 or 条件となる。
string false Empty
ou_guid 組織の GUID。
機器の所属する組織で検索する。
"+" 区切りで複数個指定することができる。
その場合、or 条件となる
string false Empty
user_guid ユーザーの GUID。
機器の所属するユーザーで検索する。
string false Empty
app_code 機器オプションパッケージの BizApp のアプリコード。
機器またはユーザーに割り当て可能なパッケージの BizApp のアプリコード。
BizApp が基本パッケージとして割当たっている場合、 機器一覧は取得されない。
string false Empty
package_guid 機能パッケージ GUID
機器に割り当てられた機能パッケージの GUID で検索する。
string false Empty
with “packages” /assets/asset/packages を返す“user” /assets/asset/user を返す"+"区切りで複数指定できる。指定しない場合返さない。 string false Empty

Example Request

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

Response Parameters

Name Description
user_guid 機器を所有しているユーザーの GUID
user_name 機器を所有しているユーザーの名前

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

Name Description Type Mandatory
company.guid 企業 GUID(ユーザ情報取得で取得した値) string True
asset.guid 機器 GUID(機器一覧取得で取得した値) string True
type コマンド内容(lock, unlock, wipe) string True

Body json Parameter

Name Description Type Mandatory Default value
message ロックメッセージ 、MacOS は未対応。 iOS は、7.0 以降でのみ対応。 string false Empty
allow_unlock_code 解除コードを許可するかどうか
"true" 解除コードによるロック解除を許可する。
"false" 解除コードによるロック解除を許可しない。
boolean false True
wipe_sd_card SD カードのワイプを行うかどうか Android の wipe の場合のみ。
"true" SD カードをワイプする。
"false" SD カードをワイプしない。 "
boolean false False
type Android iOS MacOS Windows
lock
unlock - -
wipe

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