Product Documentation

XenMobile REST APIリファレンス

Aug 02, 2016

XenMobile REST APIにより、 XenMobileコンソールで公開されるサービスを呼び出すことができます。 RESTクライアントを 使用して、RESTサービスを呼び出すことができます。 APIについて、サービスを呼び出すためにXenMobileコンソールにサインオンする必要はありません。

現在使用できるAPIの完全な一覧については、 XenMobile REST APIリファレンスのPDFファイルをダウンロードしてください。 この記事には、APIの完全なセットは含まれません。 

REST APIへのアクセスに必要な権限

REST APIにアクセスするには、次の権限 のうち1つが必要です。

  • 役割ベースのアクセス構成の一部として設定されたパブリックAPIアクセス権限(役割ベースのアクセスの設定について詳しくは、「 RBACを使用した役割の構成」を参照してください)
  • スーパーユーザー権限

REST APIサービスを呼び出すには

RESTクライアントまたはCURLコマンドを使用して、REST APIサービスを呼び出すことができます。 以下の例では、Advanced REST client for Chromeを使用します。

注意

以下の例のホスト名とポート番号は、自分の環境に合わせて変更してください。

Login

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/authentication/login

Request: { "login":"administrator", "password":"password" }

Method type: POST

Content type: application/json

localized image

Get Delivery Groups by filter

URL: /xenmobile/api/v1/deliverygroups/filter

Request コピー

{

        "start": 1,

        "sortOrder": "DESC",

        "deliveryGroupSortColumn":"id",

        "search":"add"

}

Method type: POST

Content type: application/json

localized image

REST APIの定義

以降のセクションで、このPDFに記載されている一部のAPIについて説明します。 完全なAPIの文書については、PDFを参照してください。

必ず 、以下の例のホスト名とポート番号は、自分の環境に合わせて変更してください。

パブリックAPIにログオンするには

ユーザーの資格情報を受け入れ、既存のAuthenticationManagerを使ってユーザーを認証します。 AuthenticationManagerが初めてユーザーを認証する場合、要求ヘッダーに置かれる認証トークンが生成されます。

URL:https://<ホスト名>:4443/xenmobile/api/v1/authentication/login

リクエストの種類:POST

リクエストパラメーター コピー

{ "login":"administrator", "password":"password" }

応答例 コピー

{

      "auth-token":"q483409eu82mkfrcdiv90iv0gc:q483409eu82mkfrcdiv90iv0gc"

}

CWCを介してパブリックAPIにログオンするには

ユーザーの資格情報を受け入れ、既存のAuthenticationManagerを使ってユーザーを認証します。 AuthenticationManagerが初めてユーザーを認証する場合、要求ヘッダーに置かれる認証トークンが生成されます。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/authentication/cwclogin

リクエストの種類:POST

リクエストヘッダー:認証 – CWSAuth service=<サービスキー>

リクエストパラメーター コピー

{“context”:”customer or cloud”, “customerId”:”customer ID”}

応答例 コピー

{

      "auth-token":"authentication token"

}

パブリックAPIからログアウトするには

ユーザーがログオンして現在のユーザーをログアウトした時に発行される認証トークンを削除します。 ユーザー名と認証トークンが必要です。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/authentication/logout

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

リクエストパラメーター コピー

{“login”:”administrator”}

応答例 コピー

{"Status":"user administrator logged out successfully."}

証明書を管理するには

証明書管理操作により、パブリックAPIを介して証明書を表示、削除、インポート、および追加できます。

Get all certificates

データベースのすべての証明書を返します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

リクエストパラメーター:なし

応答例 コピー

 

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": null,

      "certificate": [

              {

                      "name": "ent-root-ca",

                      "description": "test description server 1",

                      "validFrom": "2012-02-22",

                      "validTo": "2017-02-21",

                      "type": "chain",

                      "isActive": false,

                      "privateKey": "false",

                      "ca": null,

                      "id": 4656,

                      "certDetails": {

                             "signatureAlgo": "SHA1WithRSAEncryption",

                             "version": null,

                             "serialNum": "34823788180011841845726834648368716413",

                             "issuerName": {

                                     "certString": "DC=com,DC=example,CN=ent-root-ca",

                                     "emailAddress": null,

                                     "commonName": "ent-root-ca",

                                     "orgUnit": null,

                                     "org": null,

                                     "locality": null,

                                     "state": null,

                                     "country": null,

                                     "description": null

                             },

                             "subjectName": {

                                     "certString": "DC=com,DC=example,CN=ent-root-ca",

                                     "emailAddress": null,

                                     "commonName": "ent-root-ca",

                                     "orgUnit": null,

                                     "org": null,

                                     "locality": null,

                                     "state": null,

                                     "country": null,

                                     "description": null

                             }

                      }

              }

      ],

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

 

Delete certificates

特定の証明書を削除します。 削除される各証明書の証明書IDが必要です。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/publicapi/certificates

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

リクエストパラメーター コピー

{“certificateIds”:[“<certificate_id_1>”,”<certificate_id_2>”, ..., "<certificate_id_n>"]}

Import certificate as SAML certificate

SAML証明書として指定の証明書をインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/certificate/saml

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

           Content type – Multipart/form-data

リクエストパラメーター コピー

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'saml',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      },

      "certificate": null,

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

Import certificate as server certificate

サーバー証明書として指定の証明書をインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/certificate/server

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター コピー

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      },

      "certificate": null,

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

Import certificate as listener certificate

SSLリスナー証明書として指定の証明書をインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/certificate/listener

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター コピー

 

certImportData = { 

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'listener',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

 

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      },

      "certificate": null,

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

Create certificate

自己署名証明書またはCA署名が必要なCSR要求を作成します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/csr

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Application/form_url_encoded

リクエストパラメーター コピー

{

      "isSelfSign":true,

      "csrRequest":{

      "commonName":"your certificate name",

      "description":"certificate description",

      "org":"organization",

      "orgUnit":"organization unit",

      "locality":"location",

      "state":"CA",

      "country":"US",

      "isSelfSign":true

      },

"validDays":"60",

"keyLength":"1024",

"useAs":"none"

}

応答例 コピー

{

      status: 0

      message: "Success"

      csrRequest: ""

      apnsCheck: null

      certificate: null

      apnsCheckObj:

      {

      topicNameMismatch: false

      certExpired: false

      certNotYetValid: false

      malformed: false

      }

}

Export certificate

指定の証明書をダウンロードします。 次の表に、この操作を行うパラメーターを示します。

パラメーター

必須

説明

id

はい

数字で表した証明書ID

password

 

エクスポートされている証明書に割り当てられたパスワード。

exportPrivateKey

 

プライベートキーをエクスポートするかどうかを示すフラグ。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/export

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "id": "300",

      "password": "1111",

      "exportPrivateKey": true

}

応答例:成功した要求に証明書文字列を表示します。

キーストアを管理するには

パブリックAPIを介してキーストアをインポートできます。

サーバーキーストアのインポート

サーバーキーストアをインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/keystore/server

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター コピー

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

      uploadFile = <certificate file>

      uploadFile = <private key file>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      },

      "certificate": null,

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

SAMLキーストアのインポート

SAMLキーストアをインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/keystore/saml

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター コピー

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

 }

      uploadFile = <certificate file>

      uploadFile = <private key file>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      },

      "certificate": null,

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

APNsキーストアのインポート

APNSキーストアをインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/keystore/apns

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター コピー

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':apns,

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

uploadFile = <certificate file>

uploadFile = <private key file>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

                     "topicNameMismatch": false,

                     "certExpired": false,

                     "certNotYetValid": false,

                     "malformed": false

      },

      "certificate": null,

      "apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

SSLリスナーキーストアのインポート

SSLキーストアをインポートします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/certificates/import/keystore/listener

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター コピー

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':”listener”,

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

 uploadFile = <certificate file>

 uploadFile = <private key file>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "csrRequest": null,

      "apnsCheck": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      },

"certificate": null,

"apnsCheckObj": {

              "topicNameMismatch": false,

              "certExpired": false,

              "certNotYetValid": false,

              "malformed": false

      }

}

ライセンスを管理するには

パブリックAPIを介してライセンスを管理できます

Get license information

すべてのライセンスに関する情報を一覧表示します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      status: 0

      message: "Success"

      cpLicenseServer: {

              serverAddress: "192.0.2.20"

              localPort: 0

              remotePort: 27000

              serverType: "remote"

              licenseType: "none"

              isServerConfigured: true

              gracePeriodLeft: 0

              isRestartLpeNeeded: null

              isScheduleNotificationNeeded: null

                      licenseList: []

              {

                      sadate: "2015.1210"

                      notice: "Example Systems Inc."

                      vendorString: ";LT=Retail;GP=720;UDM=U;LP=90;CL=STD,ADV,ENT;SA=1;ODP=0"

                      licensesInUse: 0

                      licensesAvailable: 102

                      overdraftLicenseCount: 2

                      p_E_M: "CXM_ENTU_UD"

                      serialNumber: "cxmretailent1000user"

                      licenseType: "Retail"

                      expirationDate: "01-DEC-2015"

              }

              licenseNotification:

              {

                      id: 1

                      notificationEnabled: false

                      notifyFrequency: 7

                      notifyNumberDaysBeforeExpire: 60

                      recepientList: ""

                      emailContent: "License expiry notice"

              }

      }

}

ライセンス情報の保存

すべてのライセンス情報を保存します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "serverAddress": "192.0.2.20",

      "localPort": 0,

      "remotePort": 27000,

      "serverType": "remote",

      "licenseType": "none",

      "isServerConfigured": true,

      "gracePeriodLeft": 0,

      "isRestartLpeNeeded": true,

      "isScheduleNotificationNeeded": true,

      "licenseList": [],

      "licenseNotification": {

              "id": 1,

              "notificationEnabled": true,

              "notifyFrequency": 20,

              "notifyNumberDaysBeforeExpire": 60,

              "recepientList": "justa.name123@example.com",

              "emailContent": "Licenseexpirynotice"

      }

}

応答例 コピー

{

      "status": 0,

      "message": "Success"

}

ライセンスファイルのアップロード

指定のライセンスファイルをアップロードします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses/upload

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – Multipart/form-data

リクエストパラメーター:uploadFile =

応答例 コピー

{

      "status": 0,

      "message": "Success"

}

Activate license

指定のライセンスをアクティブにします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses/activate/{license type}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター:アクティブ化したライセンスURLにライセンスの種類を追加します。

応答例 コピー

{

      "status": 0,

      "message": "Success"

      "cpLicenseServer": null

}

すべてのライセンスの削除

すべてのライセンスを削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses/remove

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "isConnected": null

}

Test license server

ライセンスサーバーで接続性チェックを実行します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses/testserver/

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "serverAddress": "192.0.2.7",

      "localPort": 0,

      "remotePort": 27000,

      "serverType": null,

      "licenseType": null,

      "isServerConfigured": null,

      "gracePeriodLeft": 0,

      "isRestartLpeNeeded": null,

      "isScheduleNotificationNeeded": null,

      "licenseList": [],

      "licenseNotification": null

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "isConnected": true

}

Get earliest expiration date

有効期限が最も早いライセンスを検索します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/licenses/getexpirationdate

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "expiredDate": 1448956800000,

      "daysBeforeExpire": 229,

      "daysInPOC": 0

}

LDAP構成を管理するには

次の表は、LDAP構成操作で使用するパラメーターの一覧です。

パラメーター

必須

説明

primaryHost

はい

プライマリLDAPサーバーのIPアドレスまたはホスト名。 IPアドレスまたはFQDNとして入力します。

secondaryHost

いいえ

セカンダリLDAPサーバーのIPアドレスまたはホスト名。 IPアドレスまたはFQDNとして入力します。

port

はい

LDAPサーバーのポート番号

username

はい

有効なLDAPサーバーのユーザー名

password

はい

ユーザー名のパスワード

userBaseDN

はい

 

lockoutLimit

いいえ

 

lockoutTime

いいえ

 

useSecure

いいえ

 

userSearchBy

はい

UPNまたはsamaccountでユーザーを検索

domain

はい

一意のLDAPサーバーのドメイン名

domainAlias

はい

LDAPドメインのエイリアス

globalCatalogPort

いいえ

 

gcRootContext

いいえ

 

groupBaseDN

はい

 

isDefault

いいえ

LDAP構成がデフォルトかどうかを示すGET応答の一部。

いいえ

LDAP構成の更新または削除に使用される一意なIDであるGET応答の一部。

List LDAP configuration

XenMobileのLDAP構成全体を一覧で表示します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/ldap

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      “result”: [

      { "primaryHost":"192.0.2.7","secondaryHost":"","port":"389","username":"aaa@example.com","password":"1.pwd","userBaseDN":"dc=example,dc=com","groupBaseDN":"dc=example,dc=com","lockoutLimit":"0","lockoutTime":"1","useSecure":"false","userSearchBy":"upn","domain":"example.com","domainAlias":"exampleAlias","globalCatalogPort":"0","gcRootContext":"",“name”:”activeDirectory1”,”isDefault”:true },

      { "primaryHost":"192.0.2.7","secondaryHost":"","port":"389","username":"test@xmexample.com","password":"1.pwd","userBaseDN":"dc=xmexample,dc=com","groupBaseDN":"dc=xmexample,dc=com","lockoutLimit":"0","lockoutTime":"1","useSecure":"false","userSearchBy":"upn","domain":"xmexample.com","domainAlias":"xmexampleAlias","globalCatalogPort":"0","gcRootContext":"",“name”:”activeDirectory2”,”isDefault”:false }

      ]

}

Add new LDAP configuration

新しいLDAP王政を追加します。 ドメイン名は一意である必要があり、ほかのLDAP構成と同じものにはできません。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/msactivedirector

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "primaryHost":"192.0.2.7",

      "secondaryHost":"",

      "port":"389",

      "username":"aaa@example.com",

      "password":"1.pwd",

      "userBaseDN":"dc=example,dc=com",

      "groupBaseDN":"dc=example,dc=com",

      "lockoutLimit":"0",

      "lockoutTime":"1",

      "useSecure":"false",

      "userSearchBy":"upn",

      "domain":"example.com",

      "domainAlias":"exampleAlias",

      "globalCatalogPort":"0",

      "gcRootContext":""

}

応答例 コピー

{

      “status”: 0,

      “message”: “LDAP configuration created”

}

Edit LDAP configuration

既存のLDAP構成を編集します。ただし、編集操作でドメインを変更することはできません。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/msactivedirector/{name}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "primaryHost":"192.0.2.7",

      "secondaryHost":"",

      "port":"389",

      "username":"aaa@example.com",

      "password":"1.pwd",

      "userBaseDN":"dc=example,dc=com",

      "groupBaseDN":"dc=example,dc=com",

      "lockoutLimit":"0",

      "lockoutTime":"1",

      "useSecure":"false",

      "userSearchBy":"upn",

      "domain":"example.com",

      "domainAlias":"exampleAlias",

      "globalCatalogPort":"0",

      "gcRootContext":""

}

Set default LDAP configuration

指定のLDAP構成をデフォルトとして設定します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/default/{name}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

Delete LDAP configuration

指定のLDAP構成を削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/ldap/{name}

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

NetScaler Gateway構成を管理するには

NetScaler Gateway構成を管理できます。 次の表は、NetScaler Gateway操作で使用するパラメーターの一覧です。

パラメーター

必須

説明

はい

一意のNetScaler Gateway名

alias

いいえ

 

url

はい

NetScaler Gatewayの公然とアクセス可能なURL

passwordRequired

はい

 

logonType

はい

有効な値:domain-only、domain-token、domain-certificate、certificate-only、certificate-token、token-only

callback

いいえ

 

はい

NetScaler Gateway構成を追加または編集する場合にtrueまたはfalseに設定します。 このパラメーターが渡されない場合、デフォルトはfalseに設定されます。

id

いいえ

NetScaler Gateway構成の更新または削除に使用される一意なIDであるGET応答の一部。

List all NetScaler Gateway configurations

XenMobileのNetScaler Gateway構成全体を一覧で表示します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/netscaler

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      “result”: [

              { "name":"displayName",

              "alias":"",

              "url":"https://externalURl.com",

              "passwordRequired":"false",

              "logonType":"domain",

              "default":"false","id":"",

              “callback”: [{“callbackUrl”:http://example.com,

              “ip”:”192.0.2.8”}]

              },

              { "name":"displayName",

              "alias":"",

              "url":"https://externalURl.com",

              "passwordRequired":"false",

              "logonType":"domain",

              "default":"false",

              "id":"",

              “callback”: [{“callbackUrl”:http://example.com,

              “ip”:”192.0.2.8”}]

              }

      ]

}

Add new NetScaler Gateway configuration

新しいNetScaler Gateway構成を追加します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/netscaler

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "name":"displayName",

      "alias":"",

      “default”:true, "url":"https://externalURl.com",

      "passwordRequired":"false",

      "logonType":"domain”,

      “callback”: [{“callbackUrl”:http://example.com,

      “ip”:”192.0.2.8”}]

}

Edit NetScaler Gateway configuration

指定のNetScaler Gateway構成を編集します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/netscaler/{id}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "name":"displayName",

      "alias":"",

      "url":"https://externalURl.com",

      "passwordRequired":"false",

      "logonType":"domain”,

      “default”: true,

      “callback”: [{“callbackUrl”:http://ag.com,

      “ip”:”192.0.2.8”}]

}

Delete NetScaler Gateway configuration

指定のNetScaler Gateway構成を削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/netscaler/{id}

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

Set default NetScaler configuration

指定のNetScaler Gateway構成をデフォルトとして設定します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/netscaler/default/{id}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

SMSおよびSMTP通知サーバー構成を管理するには

SMSサーバーおよびSMTPサーバーの構成を追加、編集、アクティブ化(デフォルトとして設定)、および削除できます。 次の表は、SMSサーバーおよびSMTPサーバー構成の操作で使用するパラメーターの一覧です。

パラメーター

必須

説明

はい

一意のSMS/SMTP構成名です。

serverType

いいえ

GETリクエストのサーバーにより送信された通知サーバーの種類(SMSまたはSMTP)

active

いいえ

サーバーが通知に使用されているかどうかを示します。 種類ごとに1つのサーバーだけをアクティブにできます。

id

いいえ

サーバーの更新、削除、またはアクティブ化に使用される一意のID。

description

いいえ

サーバーの説明。

SMSパラメーター

key

はい

 

secret

はい

 

virtualPhoneNumber

はい

電話番号形式である必要があります。

https

はい

デフォルトはfalse。

country

はい

 

carrierGateway

はい

デフォルトはfalse。

SMTPパラメーター

secureChannelProtocol

はい

使用するセキュリティプロトコルの種類です。 有効な値:None、SSL、TLS。 デフォルトはNoneです。

port

はい

 

authentication

はい

認証を使用するかどうか指定します。 有効な値は、trueおよびfalseです。

username

認証がtrueの場合は、はい。

 

password

認証がtrueの場合は、はい。

 

msSecurePasswordAuth

はい

デフォルトはfalse。

fromName

はい

 

fromEmail

はい

 

numOfRetries

いいえ

整数。 デフォルトは5です。

timeout

いいえ

整数。 デフォルトは30です。

maxRecipients

いいえ

整数。 デフォルトは100です。

List all SMS and SMTP servers

XenMobileのすべてのSMSおよびSMTPサーバーを一覧で表示します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

                               Accept – application/json

応答例 コピー

{

      “result”: [

              { "name":"serverName","serverType":"SMS,"active":"true","id":"10"},

              { "name":"serverName2","serverType":"SMTP,"active":"true","id":"10"},

              { "name":"serverName3","serverType":"SMS,"active":"false","id":"10"}

      ]

}

Get server details

サーバーIDによりサーバーに関する詳細を取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/{id}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

                               Accept – application/json

SMS応答の例 コピー

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

SMTP応答の例 コピー

{

      name":"displayName",

      "description":"",

      "server":"192.0.2.12",

      "secureChannelProtocol":"true",

      "port":"345",

      "authentication":"false”,

      “username”: “test”,

      “password”: “testPassword”,

      "msSecurePasswordAuth":"true",

      "fromName":"Email name",

      "fromEmail":test@example.com,

      "numOfRetries":5,

      "timeout":30,

      "maxRecipients":100

}

Add SMS server configuration

SMSサーバー構成を追加します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/sms

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Edit SMS server configuration

指定のSMSサーバー構成を編集します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/sms/{id}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Add SMTP server configuration

SMTPサーバー構成を追加します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/smtp

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      name":"displayName",

      "description":"",

      "server":"192.0.2.9"

      "secureChannelProtocol":"true",

      "port":"345",

      "authentication":"false”,

      “username”: “test”,

      “password”: “testPassword”,

      "msSecurePasswordAuth":"true",

      "fromName":"Email name",

      "fromEmail":test@example.com,

      "numOfRetries":5,

      "timeout":30,

      "maxRecipients":100

}

Edit SMTP configuration

指定のSMTP構成を編集します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/smtp/{id}

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      name":"displayName",

      "description":"Edited description",

      "server":"192.0.2.9"

      "secureChannelProtocol":"true",

      "port":"345",

      "authentication":"false”,

      “username”: “test”,

      “password”: “testPassword”,

      "msSecurePasswordAuth":"true",

      "fromName":"Email name",

      "fromEmail":test@example.com,

      "numOfRetries":5,

      "timeout":30,

      "maxRecipients":100

}

Delete server configuration

指定のSMSまたはSMTPサーバー構成を削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/{id}

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

Set default SMS configuration

指定のSMSサーバー構成をデフォルトとして設定します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/activate/sms/{id}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

Set default SMTP configuration

指定のSMTPサーバー構成をデフォルトとして設定します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/notificationserver/activate/smtp/{id}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

ローカルユーザーとグループを管理するには

次のサービスを使用すると、ローカルユーザーとグループを管理できます。

Get all users

すべてのローカルユーザーを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "result": [

              {

                     "userid": 8,

                      "username": "admin",

                      "password": null,

                      "confirmPassword": null,

                      "groups": [],

                      "attributes": {

                             "company": "example"

                      },

                      "role": "ADMIN",

                      "roles": null,

                      "createdOn": "1/10/15 11:42 AM",

                      "lastAuthenticated": "1/10/15 11:42 AM",

                      "domainName": null,

                      "adUser": false,

                      "vppUser": false

              }

      ]

}

Get one user

指定のローカルユーザーを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups/{name}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "result": {

              "userid": 8,

              "username": "admin",

              "password": null,

              "confirmPassword": null,

              "groups": [],

              "attributes": {

                      "company": "example"

              },

              "role": "ADMIN",

              "roles": null,

              "createdOn": "1/10/15 11:42 AM",

              "lastAuthenticated": "1/10/15 11:42 AM",

              "domainName": null,

              "adUser": false,

              "vppUser": false

      }

}

Add user

指定の属性のユーザーを追加します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "attributes": {

              "badpwdcount": "4",

              "asuseremail": "justa.name@example.com",

              "company": "example",

              "mobile": "4695557854"

              },

      "groups": [

              "MSP"

              ],

      "role": "USER",

      "username": "justaname_XX",

      "password": "password"

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": {

              "userid": 0,

              "username": "justaname_XX",

              "password": "password",

              "confirmPassword": null,

              "groups": [

                      "MSP"

              ],

              "attributes": {

                      "badpwdcount": "4",

                      "asuseremail": "justa.name@example.com",

                      "company": "example",

                      "mobile": "4695557854"

              },

              "role": "USER",

              "roles": null,

              "createdOn": null,

              "lastAuthenticated": null,

              "domainName": null,

              "adUser": false,

              "vppUser": false

      }

}

Update user

ユーザー属性を更新します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "attributes": {

              "badpwdcount": "4",

              "asuseremail": "justa.name@example.com",

              "company": "example",

              "mobile": "4695557854"

              },

      "groups": [

              "MSP"

              ],

      "role": "USER",

      "username": "justaname_XX",

      "password": "password"

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": {

              "userid": 108,

              "username": "justaname_XX",

              "password": null,

              "confirmPassword": null,

              "groups": [

                      "MSP"

              ],

              "attributes": {

                      "badpwdcount": "4",

                      "asuseremail": "justa.name@example.com",

                      "company": "example",

                      "mobile": "4695557854"

              },

              "role": "USER",

              "roles": null,

              "createdOn": "3/27/15 1:10 PM",

              "lastAuthenticated": "3/27/15 1:10 PM",

              "domainName": null,

              "adUser": false,

              "vppUser": false

      }

}

Change user password

ユーザーのパスワードをリセットします。また、更新ローカルユーザー呼び出しでユーザーのパスワードを変更できます。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups/resetpassword

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "username": “administrator”,

      “password”: “newPassword”

}

応答例 コピー

 

Response Errors:

1250 – User id not found

1252 – Failed to reset the password

Password can also be changed in the update local user call.

 

Delete users

指定のユーザーを削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups/resetpassword

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{ justaname XX }

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": null

}

Delete one user

指定のユーザーを削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups/

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": null

}

Import provisioning file

ローカルユーザーデータを含むファイルをアップロードします。 更新されるファイルは.csv形式である必要があります。 プロビジョニングファイルについて詳しくは、「プロビジョニングファイル形式」を参照してください。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/localusersgroups/importprovisioningfile

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

importdata={"fileType:"user"}

uploadfile=<file to be uploaded.csv>

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": null

}

アプリを管理するには

以下のサービスを使用すると、アプリを管理できます。

Get all apps by filter

指定のフィルターパラメーターを元にアプリを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/application/filter

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン
                          コンテンツの種類 – application/json

サンプル要求データ コピー

 

{

      "start": 0,

      "limit": 10,

 

      "applicationSortColumn": "name",

      "sortOrder": "DESC",

      "enableCount": false,

      "search": "Worx",

      "filterIds":"['application.deliverygroup#<DG_Name>@_fn_@app.dg','application.deliverygroup#<DG_Name>@_fn_@app.dg']"

}

 

 

サンプル応答データ コピー

{

    "status": 0,

    "message": "Success",

    "applicationListData": {

        "totalMatchCount": 2,

        "totalCount": 2,

        "appList": [{

            "id": 2,

            "name": "WorxNotes",

            "description": "Worx Notes Application",

            "createdOn": "6/7/16 3:55 PM",

            "lastUpdated": "6/7/16 5:11 PM",

            "disabled": false,

            "nbSuccess": 0,

            "nbFailure": 0,

            "nbPending": 0,

            "schedule": null,

            "permitAsRequired": true,

            "iconData": "iVBORw0KGgoAAAANSUhEUgAAAHgAAAB4CAYAAAA5ZDbSAAA...........",

            "appType": "MDX",

            "categories": ["Default"],

            "roles": null,

            "workflow": null,

            "vppAccount": null

        }, {

            "id": 1,

            "name": "Angry Bird",

            "description": "",

            "createdOn": "6/7/16 3:53 PM",

            "lastUpdated": "6/7/16 3:54 PM",

            "disabled": false,

            "nbSuccess": 0,

            "nbFailure": 0,

            "nbPending": 0,

            "schedule": null,

            "permitAsRequired": true,

            "iconData": "/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChA...",

            "appType": "App Store App",

            "categories": ["Default"],

            "roles": null,

            "workflow": null,

            "vppAccount": null

        }]

    }

}

Get mobile apps by container

指定のコンテナーのモバイルアプリを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/application/mobile/{containerId}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "result": {

              "id": 14,

              "name": "testApp",

              "description": "",

              "createdOn": null,

              "lastUpdated": null,

              "disabled": false,

              "nbSuccess": 0,

              "nbFailure": 0,

              "nbPending": 0,

              "schedule": {

                      "enableDeployment": true,

                      "deploySchedule": "NOW",

                      "deployScheduleCondition": "EVERYTIME",

                      "deployDate": null,

                      "deployTime": null,

                      "deployInBackground": false

              },

              "iconData": "",

              "appType": "MDX",

              "categories": [

                      "Default"

              ],

              "roles": [],

              "workflow": null,

              "ios": {

                      "displayName": "GoToMeeting",

                      "description": "G2MW_IOS_5.3.3_075_01",

                      "paid": false,

                      "removeWithMdm": true,

                      "preventBackup": true,

                      "appVersion": "5.3.3.075",

                      "minOsVersion": "",

                      "maxOsVersion": "",

                      "excludedDevices": "",

                      "avppParams": null,

                      "avppTokenParams": null,

                      "rules": null,

                      "appType": "mobile_ios",

                      "uuid": "8e69d397-48bb-4f29-a95c-dd7b16665c1c",

                     "id": 0,

                      "store": {

                             "rating": {

                                     "rating": 0,

                                     "reviewerCount": 0

                             },

                             "screenshots": [],

                             "faqs": [],

                             "storeSettings": {

                                     "rate": true,

                                     "review": true

                             }

                      },

                      "policies": [

                             {

                                     "policyName": "ReauthenticationPeriod",

                                     "policyValue": "480",

                                     "policyType": "integer",

                                     "policyCategory": "Authentication",

                                     "title": "Reauthentication period (minutes)",

                                     "description": "\nDefines the period before a user is challenged to authenticate again. ",

                                     "units": "minutes",

                                     "explanation": null

                             },

                             {

                                     "policyName": "BlockJailbrokenDevices",

                                     "policyValue": "true",

                                     "policyType": "boolean",

                                     "policyCategory": "Device Security",

                                     "title": "Block jailbroken or rooted",

                                     "description": "\nIf On, the application is locked when the device is jailbroken or rooted.",

                                     "units": null,

                                     "explanation": null

                             },

                             {

                                     "policyName": "CertificateLabel",

                                     "policyValue": "",

                                     "policyType": "string",

                                     "policyCategory": "Network Access",

                                     "title": "Certificate label",

                                     "description": "\nThe label for the certificate.\n                                                                   Default value is empty.\n                                              ",

                                     "units": null,

                                     "explanation": null

                             }

                      ]

              },

              "android": null,

              "android_knox": null,

              "android_work": null,

              "windows": null,

              "windows_tab": null

      }

}

Get public store apps by container

指定のコンテナーからパブリックストアアプリを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/application/mobile/appstore/{containerId}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

Delete app container

指定のアプリコンテナーを削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/application/{containerId}

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

デリバリーグループ構成を管理するには

以下のサービスを使用すると、デリバリーグループ構成を管理できます。

Get delivery groups by filter

指定のフィルターパラメーターを使ってデリバリーグループを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/deliverygroups/filter

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

{

    "start": 1,

    "sortOrder": "DESC",

    "deliveryGroupSortColumn": "id",

    “limit”:10,

    "search": "add"

}

応答例 コピー

{

         "status": 0,

         "message": "Success",

         "dgListData": {

                 "totalMatchCount": 7,

                 "totalCount": 10,

                 "dgList": [

                          {

                                   "id": null,

                                   "name": "add delivery group 6.0",

                                   "description": "testing add delivery group 6.0",

                          "groups": [[{

                                            {

                                                    "id": 1null,

                                   "userListId": 1null,

                                   "name": "MSPTESTLOCALGROUP",

                                   "uniqueName": "MSPTESTLOCALGROUP",

                                   "uniqueId": "MSPTESTLOCALGROUP",

                                   "domainName": "local",

                                   "primaryToken": 0null,

                                            }"objectSid": null

                                   ],},

                          {

                                   "id": null,

                                   "userListId": null,

                                   "name": "AC08EP61S75",

                                   "uniqueName": "AC08EP61S75",

                                   "uniqueId": "AC08EP61S75",

                                   "domainName": "local",

                                   "primaryToken": null,

                                   "objectSid": null

                          }],

                          "users": [{

                                   "uniqueName": null,

                                   "domainName": "local",

                                   "name": null,

                                   "objectId": "shankar",

                                   "customProperties": {

                                            "name": "value",

                                            "name1": "value1"

                                   },

                                   "uniqueId": "shankar"

                          }],

                                   "zoneId": null,

                                   "zoneDomain": null,

                                   "rules": "{\"AND\":[{\"values\":{\"stringOperator\":\"eq\",\"value\":\"shankar.ganesh@citrix.com\"},\"ruleId\":\"001-restrictUserPropEmail\"}]}",

                                   "disabled": false,

                                   "lastUpdated": 1427144713353,

                                   "anonymousUser": true,

                                   "roledefLangVersionId": 1,

                                   "applications": [

                                            {

                                                    "name": "Web Link",

                                                    "required": false

                                            },

                                            {

                                                    "name": "GoogleApps_SAML",

                                                    "required": true

                                            }

                                   ],

                                   "devicePolicies": [

                                            "test terms conditions"

                                   ],

                                   "smartActions": [

                                            "shankar ganesh"

                                   ],

                                   "nbSuccess": 0,

                                   "nbFailure": 0,

                                   "nbPending": 0

                          },

                          {

                                   "id": null,

                                   "name": "add delivery group 5.0",

                                   "description": "testing add delivery group 5.0",

                                   "groups": [

                                            {

                                                    "id": 1,

                                                    "userListId": 1,

                                                    "name": "MSP",

                                                    "uniqueName": "MSP",

                                                    "uniqueId": "MSP",

                                                    "domainName": "local",

                                                    "primaryToken": 0

                                            }

                                   ],

                                   "zoneId": null,

                                   "zoneDomain": null,

                                   "rules": "{\"AND\":[{\"values\":{\"stringOperator\":\"eq\",\"value\":\"shankar.ganesh@citrix.com\"},\"ruleId\":\"001-restrictUserPropEmail\"}]}",

                                   "disabled": false,

                                   "lastUpdated": 1426891345698,

                                   "anonymousUser": true,

                                   "roledefLangVersionId": 1,

                                   "applications": [

                                            {

                                                    "name": "GoogleApps_SAML",

                                                    "required": true

                                            },

                                            {

                                                    "name": "Web Link",

                                                    "required": false

                                           }

                                   ],

                                   "devicePolicies": [

                                            "test terms conditions"

                                   ],

                                   "smartActions": [

                                            "shankar ganesh"

                                   ],

                                   "nbSuccess": 0,

                                   "nbFailure": 0,

                                   "nbPending": 0

                          }

                 ]

         }

}

Get delivery group by name

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/deliverygroups/{name}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "role": {

              "id": null,

              "name": "AllUsers",

              "description": "default role",

              "groups": [],

              "zoneId": null,

              "zoneDomain": null,

              "rules": null,

              "disabled": false,

              "lastUpdated": null,

              "anonymousUser": false,

              "roledefLangVersionId": 1,

              "applications": [

                      {

                             "name": "test mdx",

                             "required": false

                      },

                      {

                             "name": "test all",

                             "required": false

                      },

                      {

                             "name": "justa test",

                             "required": false

                      },

                      {

                             "name": "test enterprise",

                             "required": false

                      },

                      {

                             "name": "name test",

                             "required": false

                      }

              ],

              "devicePolicies": [

                      "test terms conditions"

              ],

              "smartActions": [

                      "justa name"

              ],

              "nbSuccess": 0,

              "nbFailure": 0,

              "nbPending": 0

      }

}

Edit delivery group

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/deliverygroups

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

 

{

    "name": "temp3",

    "description": "temp3 desc",

    "applications": [
{

                   "name": "TESTAPP",

                    "priority": -1,

                    "required": false

                                }       ],
       "devicePolicies": [
           {
                   "name":"test terms conditions",
                   "priority":-1
            }
       ],

       "smartActions": [
           {
               "name":"Smart Action Name 1",
               "priority":-1
            }
       ]
,
    "groups": [

        {

   "uniqueName": "AC08EP61S75",

            "domainName": "local",

            "name": "AC08EP61S75",

            "objectSid": "AC08EP61S75",

"uniqueId": "AC08EP61S75",

"customProperties": {

        "gr1": "gr1",

        "gr2": "gr2"

    }

        }

    ],

    "users": [

        {

            "uniqueName": "testuser",

            "domainName": "local",

            "name": " testuser ",

            "objectId": " testuser "

        }

    ],

    "rules": "{\"AND\":[{\"eq\":{\"property\":{\"type\":\"USER_PROPERTY\",\"name\":\"mail\"},\"type\":\"STRING\",\"value\":\" testuser@citrix.com\"}}]}"

}

 

応答例 コピー

 

{

         "status": 0,

         "message": "Success",

"role": {

                 "id": null,

                 "name": "temp4",

                 "description": "temp4 desc",

                 "zoneId": null,

                 "zoneDomain": null,

                 "rules": "{\"AND\":[{\"eq\":{\"property\":{\"type\":\"USER_PROPERTY\",\"name\":\"mail\"},\"type\":\"STRING\",\"value\":\"tempuser@citrix.com\"}}]}",

                 "disabled": false,

                 "lastUpdated": null,

                 "anonymousUser": false,

                 "roledefLangVersionId": null,

                 "applications": [

                          {

                          "name": "TESTAPP2",

                          "priority": -1,

                          "required": false

                 },

{

                          "name": "TESTAPP2",

                          "priority": -1,

                          "required": false

                 }

                 ],

                 "devicePolicies": [

                          {

                          "name": "TestPolicy1",

                          "priority": -1

                 },

{

                          "name": "TestPolicy",

                          "priority": -1

                 }

                 ],

                 "smartActions": [

{

                          "name": "TestAction2",

                          "priority": -1

                 },

{

                          "name": "TestAction3",

                          "priority": -1

                 }       

         ],

                 "nbSuccess": 0,

                 "nbFailure": 0,

                 "nbPending": 0,

                 "groups": [{

                             "uniqueName": "AC08EP61S75",

                           "domainName": "local",

                          "name": "AC08EP61S75",

                           "objectSid": "AC08EP61S75",

                          "uniqueId": "AC08EP61S75",

                          "customProperties": {

                             "gr1": "gr1",

                              "gr2": "gr2"

                           }

                 }],

                 "users": [{

                          "uniqueName": " tempuser ",

                          "domainName": "local",

                          "name": " tempuser ",

                          "objectId": " tempuser ",

                          "customProperties": null,

                          "uniqueId": " tempuser "

                 }]

       }

 

Add delivery group

デリバリーグループを追加します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/deliverygroups

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

{

    "name": "temp3",

    "description": "temp3 desc",

    "applications": [
{

                   "name": "TESTAPP",

                    "priority": -1,

                    "required": false

                                }       ],
       "devicePolicies": [
           {
                   "name":"test terms conditions",
                   "priority":-1
            }
       ],

       "smartActions": [
           {
               "name":"Smart Action Name 1",
               "priority":-1
            }
       ]
,
    "groups": [

        {

   "uniqueName": "AC08EP61S75",

            "domainName": "local",

            "name": "AC08EP61S75",

            "objectSid": "AC08EP61S75",

"uniqueId": "AC08EP61S75",

"customProperties": {

        "gr1": "gr1",

        "gr2": "gr2"

    }}

    ],

    "users": [

        {

            "uniqueName": "testuser",

            "domainName": "local",

            "name": " testuser ",

            "objectId": " testuser "

        }

    ],

    "rules": "{\"AND\":[{\"eq\":{\"property\":{\"type\":\"USER_PROPERTY\",\"name\":\"mail\"},\"type\":\"STRING\",\"value\":\" testuser@citrix.com\"}}]}"

}

応答例 コピー

{

         "status": 0,

         "message": "Success",

"role": {

                 "id": null,

                 "name": "temp4",

                 "description": "temp4 desc",

                 "zoneId": null,

                 "zoneDomain": null,

                 "rules": "{\"AND\":[{\"eq\":{\"property\":{\"type\":\"USER_PROPERTY\",\"name\":\"mail\"},\"type\":\"STRING\",\"value\":\"shankar.ganesh@citrix.com\"}}]}",

                 "disabled": false,

                 "lastUpdated": null,

                 "anonymousUser": false,

                 "roledefLangVersionId": null,

                 "applications": [

                          {

                          "name": "TESTAPP2",

                          "priority": -1,

                          "required": false

                  },

{

                          "name": "TESTAPP2",

                          "priority": -1,

                          "required": false

                 }

                 ],

                 "devicePolicies": [

                          {

                          "name": "TestPolicy1",

                          "priority": -1

                 },

{

                          "name": "TestPolicy",

                          "priority": -1

                 }

                 ],

                 "smartActions": [

{

                          "name": "TestAction2",

                          "priority": -1

                 },

{

                          "name": "TestAction3",

                          "priority": -1

                 }       

         ],

                 "nbSuccess": 0,

                 "nbFailure": 0,

                 "nbPending": 0,

                 "groups": [{

                             "uniqueName": "AC08EP61S75",

            "domainName": "local",

            "name": "AC08EP61S75",

            "objectSid": "AC08EP61S75",

"uniqueId": "AC08EP61S75",

"customProperties": {

        "gr1": "gr1",

        "gr2": "gr2"

    }            }],

                 "users": [{

                          "uniqueName": " tempuser ",

                          "domainName": "local",

                          "name": " tempuser ",

                          "objectId": " tempuser ",

                          "customProperties": null,

                          "uniqueId": " tempuser "

                 }]

       }

Delete delivery group

指定のデリバリーグループを削除します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/deliverygroups

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

[ "add delivery group 11.0" ]

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "roleNames": [

              "add delivery group 11.0"

      ]

}

Enable or Disable Delivery Group

指定のデリバリーグループを有効化または無効化します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/deliverygroups/{delivery group name}/{enable/disable}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "roleName": "AllUsers"

}

サーバープロパティを管理するには

以下のサービスを使用すると、XenMobileサーバープロパティを管理できます。

Get all server properties

すべての現在のXenMobileサーバーのプロパティを取得できます。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/serverproperties

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "allEwProperties": [

              {

                      "id": 1,

                      "name": "ios.mdm.pki.ca-root.certificatefile",

                      "value": "c:/opt/sas/sw/tomcat/inst1/conf/pki-ca-root.crt.pem",

                      "displayName": "ios.mdm.pki.ca-root.certificatefile",

                      "description": "",

                      "defaultValue": "c:/opt/sas/sw/tomcat/inst1/conf/pki-ca-root.crt.pem",

                      "displayFlag": false,

                      "editFlag": true,

                      "deleteFlag": false,

                      "markDeleted": false

              } ,

              {

                      "id": 2,

                      "name": "ios.mdm.https.host",

                      "value": "192.0.2.4",

                      "displayName": "ios.mdm.https.host",

                      "description": "",

                      "defaultValue": "192.0.2.4",

                      "displayFlag": false,

                      "editFlag": false,

                      "deleteFlag": false,

                      "markDeleted": false

              },

              {

                      "id": 3,

                      "name": "ios.mdm.enrolment.checkRemoteAddress",

                      "value": "false",

                      "displayName": "iOS Device Management Enrollment - Check Remote Address",

                      "description": "",

                      "defaultValue": "false",

                      "displayFlag": true,

                      "editFlag": true,

                      "deleteFlag": false,

                      "markDeleted": false

              },

      ]

}

Get server properties by filter

指定のフィルターパラメーターを使ってサーバープロパティを取得します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/serverproperties/filter

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "start": 0,

      "limit": 1000,

      "orderBy": "name",

      "sortOrder": "desc",

      "searchStr": "justaserver1"

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "allEwProperties": [

              {

                      "id": 154,

                      "name": "justaserver123",

                      "value": "justaserver1",

                      "displayName": "justarserver display name",

                      "description": "justaserver description",

                      "defaultValue": "justaserver1",

                      "displayFlag": true,

                      "editFlag": true,

                      "deleteFlag": true,

                      "markDeleted": false

              }

      ]

}

Add server property

指定のサーバープロパティを追加します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/serverproperties

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "name": "Key 2",

      "value": "Value 1",

      "displayName": "Display Name 1",

      "description": "Description 1"

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "allEwProperties": null

}

Edit server properties

指定のサーバープロパティを編集します。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/serverproperties

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "name": "Key 2",

      "value": "Value 1",

      "displayName": "Display Name 2",

      "description": "Description 2"

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": null

}

Reset server properties

指定のサーバープロパティをリセットします。

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/serverproperties/reset

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "names": [,

              "justaname7"

              ]

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "allEwProperties": null

}

Delete server properties

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/serverproperties

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエストパラメーター コピー

{

      "justaname3",

      "justaname4"

}

応答例 コピー

{

      "status": 0,

      "message": "Success",

      "user": null

}

デバイスを管理するには

以下のサービスを使用すると、XenMobileでデバイスを管理できます。

Get Devices by Filter

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/filter

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リスエストパラメーターはすべて任意です。

sortOrderの有効な値は、ASC、DSC、およびDESCです。

sortColumnの有効な値は、ID、SERIAL、IMEI、ACTIVESYNCID、WIFIMAC、BLUETOOTHMAC、OSFAMILY、SYSTEM_OEM、SYSTEM_PLATFORM、SYSTEM_OS_VERSION、DEVICE_PROPERTY、LASTAUTHDATE、INACTIVITYDAYS、ISACTIVE、LASTUSER、BLCOMPLIANT、WLCOMPLIANT、RLCOMPLIANT、MANAGED、SHAREABLE、およびBULKPROFILESTATUSです。

リクエストパラメーター コピー

{

    "start": "0-999",

    "limit": "0-999",

    "sortOrder": "ASC",

    "sortColumn": "ID",

    "search": "Any search term",

    "enableCount": "false",

    "constraints": "{'constraintList':[{'constraint':'DEVICE_OS_FAMILY','parameters':[{'name':'osFamily','type':'STRING','value':'iOS'}]}]}",

    "filterIds": "['group#/group/MSP@_fn_@normal']"

}

応答例 コピー

{

    "id": "1-9999999",

    "jailBroken": "true/false",

    "managed": "true/false",

    "gatewayBlocked": "true/false",

    "deployFailed": "1-999",

    "deployPending": "1-999",

    "deploySuccess": "1-999",

    "mdmKnown": "true/false",

    "mamRegistered": "true/false",

    "mamKnown": "true/false",

    "userName": "user name",

    "serialNumber": "serial number",

    "imeiOrMeid": "IMEI/MEID",

    "activeSyncId": "Active sync ID",

    "wifiMacAddress": "WiFi MAC address",

    "blueToothMacAccress": "Bluetoothi MAC address",

    "devicePlatform": "Device platform",

    "osVersion": "Operating system version of the device",

    "deviceModel": "Device model information",

    "lastAccess": "Timestamp when the device was last accessed",

    "inactivityDays": "Number of days device has been inactive",

    "shareable": "Flag indicating if the device is shareable",

    "sharedStatus": "Get shareable status of the device",

    "depRegistered": "Flag indicating if the device is DEP registered",

    "deviceName": "Name of the device",

    "deviceType": "Phone/Tablet",

    "productName": "Product name",

    "platform": "Platform of the device"

}

Get Devices by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "device": {

    "htcMdm": true,

    "managedByZMSP": true,

    "serialNumber": "string",

    "id": 0,

    "applications": [

      {

        "resourceType": "APP_NATIVE",

        "resourceTypeLabel": "string",

        "packageInfo": "string",

        "statusLabel": "string",

        "lastUpdate": 0,

        "status": "SUCCESS",

        "name": "string"

      }

    ],

    "smartActions": [

      {

        "resourceType": "APP_NATIVE",

        "resourceTypeLabel": "string",

        "packageInfo": "string",

        "statusLabel": "string",

        "lastUpdate": 0,

        "status": "SUCCESS",

        "name": "string"

      }

    ],

    "platform": "string",

    "osFamily": "WINDOWS",

    "nbSuccess": 0,

    "nbFailure": 0,

    "nbPending": 0,

    "deliveryGroups": [

      {

        "statusLabel": "string",

        "linkey": "string",

        "lastUpdate": 0,

        "status": "SUCCESS",

        "name": "string"

      }

    ],

    "lastAuthDate": 0,

    "sharedStatus": "INACTIVE",

    "managed": true,

    "smgStatus": "ACCESS_ALLOWED",

    "mdmKnown": true,

    "mamKnown": true,

    "mamRegistered": true,

    "lastUsername": "string",

    "imei": "string",

    "activesyncid": "string",

    "wifimac": "string",

    "bluetoothmac": "string",

    "inactivityDays": 0,

    "shareable": true,

    "bulkProfileStatus": "NO_BULK",

    "deviceType": "string",

    "softwareInventory": [

      {

        "version": "string",

        "blacklistCompliant": true,

        "suggestedListCompliant": true,

        "packageInfo": "string",

        "installCount": 0,

        "installTimeStamp": 0,

        "author": "string",

        "container": 0,

        "name": "string",

        "size": 0

      }

    ],

    "deviceActions": [

      {

        "actionType": "WIPE",

        "failedTime": 0,

        "doneTime": 0,

        "askedTime": 0

      }

    ],

    "managedSoftwareInventory": [

      {

        "version": "string",

        "blacklistCompliant": true,

        "suggestedListCompliant": true,

        "packageInfo": "string",

        "installCount": 0,

        "installTimeStamp": 0,

        "author": "string",

        "container": 0,

        "name": "string",

        "size": 0

      }

    ],

    "policies": [

      {

        "resourceType": "APP_NATIVE",

        "resourceTypeLabel": "string",

        "packageInfo": "string",

        "statusLabel": "string",

        "lastUpdate": 0,

        "status": "SUCCESS",

        "name": "string"

      }

    ],

    "active": true,

    "xmlId": "string",

    "deviceUsers": [

      {

        "user": {

          "displayName": "string",

          "id": 0,

          "xmlId": "string",

          "properties": [

            {

              "displayName": "string",

              "id": 0,

              "b64": true,

              "group": "string",

              "name": "string",

              "value": "string"

            }

          ]

        },

        "lastAuthDate": 0,

        "prevAuthDate": 0,

        "userLogin": "string"

      }

    ],

    "packageStates": [

      {

        "packageName": "string",

        "packageId": 0,

        "statusLabel": "string",

        "date": 0,

        "status": "PENDING"

      }

    ],

    "pushState": "ENQUEUED",

    "pushStateLabel": "string",

    "lastPushDate": 0,

    "lastSentNotification": 0,

    "lastRepliedNotification": 0,

    "strongId": "string",

    "lastSoftwareInventoryTime": 0,

    "firstConnectionDate": 0,

    "lastIOSProfileInventoryTime": 0,

    "lastUser": {

      "displayName": "string",

      "id": 0,

      "xmlId": "string",

      "properties": [

        {

          "displayName": "string",

          "id": 0,

          "b64": true,

          "group": "string",

          "name": "string",

          "value": "string"

        }

      ]

    },

    "blacklistCompliant": true,

    "suggestedListCompliant": true,

    "requiredListCompliant": true,

    "devicePropertiesTimestamp": 0,

    "revoked": true,

    "mamDeviceId": "string",

    "deviceToken": "string",

    "typeInst": 0,

    "appLock": true,

    "appWipe": true,

    "mamReady": true,

    "validCertificates": [

      {

        "credentialProviderId": "string",

        "type": "string",

        "issuerName": "string",

        "startDate": 0,

        "endDate": 0,

        "revoked": true,

        "certificateNumber": "string"

      }

    ],

    "revokedCertificates": [

      {

        "credentialProviderId": "string",

        "type": "string",

        "issuerName": "string",

        "startDate": 0,

        "endDate": 0,

        "revoked": true,

        "certificateNumber": "string"

      }

    ],

    "authorizeEnabled": true,

    "revokeEnabled": true,

    "lockEnabled": true,

    "cancelLockEnabled": true,

    "unlockEnabled": true,

    "cancelUnlockEnabled": true,

    "containerLockEnabled": true,

    "cancelContainerLockEnabled": true,

    "containerUnlockEnabled": true,

    "cancelContainerUnlockEnabled": true,

    "containerPwdResetEnabled": true,

    "cancelContainerPwdResetEnabled": true,

    "wipeEnabled": true,

    "cancelWipeEnabled": true,

    "clearRestrictionsEnabled": true,

    "cancelClearRestrictionsEnabled": true,

    "corpWipeEnabled": true,

    "cancelCorpWipeEnabled": true,

    "sdCardWipeEnabled": true,

    "cancelSdCardWipeEnabled": true,

    "locateEnabled": true,

    "cancelLocateEnabled": true,

    "enableTrackingEnabled": true,

    "disableTrackingEnabled": true,

    "disownEnabled": true,

    "activationLockBypassEnabled": true,

    "ringEnabled": true,

    "cancelRingEnabled": true,

    "newPinCode": "string",

    "oldPinCode": "string",

    "lockMessage": "string",

    "resetPinCode": true,

    "scanTime": "string",

    "screenSharingPwd": "string",

    "iosprofileInventory": [

      {

        "iosConfigInventories": [

          {

            "description": "string",

            "type": "string",

            "organization": "string",

            "identifier": "string",

            "name": "string"

          }

        ],

        "description": "string",

        "organization": "string",

        "managed": true,

        "identifier": "string",

        "receivedDate": 0,

        "encrypted": true,

        "name": "string"

      }

    ],

    "iosprovisioningProfileInventory": [

      {

        "managed": true,

        "uuid": "string",

        "expiryDate": 0,

        "name": "string"

      }

    ],

    "erasedMemoryCard": true,

    "gpsCoordinates": [

      {

        "gpsTimestamp": 0

      }

    ],

    "lastGpsCoordinate": {

      "gpsTimestamp": 0

    },

    "gpsFilterStartDate": 0,

    "gpsFilterEndDate": 0,

    "wipePinCode": "string",

    "lockPhoneNumber": "string",

    "dstDevIdUsed": true,

    "dstValue": "string",

    "smartActionsFailure": true,

    "policiesFailure": true,

    "applicationsFailure": true,

    "touchdownProperties": [

      {

        "category": "string",

        "name": "string",

        "value": "string"

      }

    ],

    "appUnwipeEnabled": true,

    "requestMirroringEnabled": true,

    "cancelRequestMirroringEnabled": true,

    "stopMirroringEnabled": true,

    "cancelStopMirroringEnabled": true,

    "knownByZMSP": true,

    "wipeDeviceFlag": true,

    "lockDeviceFlag": true,

    "appWipeEnabled": true,

    "appLockEnabled": true,

    "appUnlockEnabled": true,

    "bulkEnrolled": true,

    "nbAvailable": 0,

    "hasContainer": true,

    "connected": true,

    "properties": [

      {

        "displayName": "string",

        "id": 0,

        "b64": true,

        "group": "string",

        "name": "string",

        "value": "string"

      }

    ]

  }

}

Get Device Apps by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}/apps

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "applications": [

    {

      "resourceType": "APP_NATIVE",

      "resourceTypeLabel": "string",

      "packageInfo": "string",

      "statusLabel": "string",

      "lastUpdate": 0,

      "status": "SUCCESS",

      "name": "string"

    }

  ]

}

Get Device Actions by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}/actions

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "actions": [

    {

      "resourceType": "APP_NATIVE",

      "resourceTypeLabel": "string",

      "packageInfo": "string",

      "statusLabel": "string",

      "lastUpdate": 0,

      "status": "SUCCESS",

      "name": "string"

    }

  ]

}

Get Device Delivery Groups by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}/deliverygroups

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deliveryGroups": [

    {

      "statusLabel": "string",

      "linkey": "string",

      "lastUpdate": 0,

      "status": "SUCCESS",

      "name": "string"

    }

  ]

}

Get Managed Software Inventory by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}/managedswinventory

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "softwareInventory": [

    {

      "version": "string",

      "blacklistCompliant": true,

      "suggestedListCompliant": true,

      "packageInfo": "string",

      "installCount": 0,

      "installTimeStamp": 0,

      "author": "string",

      "container": 0,

      "name": "string",

      "size": 0

    }

  ]

}

Get Policies by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}/policies

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "policies": [

    {

      "resourceType": "APP_NATIVE",

      "resourceTypeLabel": "string",

      "packageInfo": "string",

      "statusLabel": "string",

      "lastUpdate": 0,

      "status": "SUCCESS",

      "name": "string"

    }

  ]

}

Get Software Inventory by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/{device_id}/softwareinventory

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "softwareInventory": [

    {

      "version": "string",

      "blacklistCompliant": true,

      "suggestedListCompliant": true,

      "packageInfo": "string",

      "installCount": 0,

      "installTimeStamp": 0,

      "author": "string",

      "container": 0,

      "name": "string",

      "size": 0

    }

  ]

}

Get GPS Coordinates by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/locations/{device_id}

クエリパラメーター

startDate – 座標フィルターの開始日
endDate – 座標フィルターの終了日

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceCoordinates": {

    "deviceCoordinateList": {

      "deviceCoordinateList": [

        {

          "gpsTimestamp": 0

        }

      ],

      "startDate": 0,

      "endDate": 0

   }

}

Send Notification to a List of Devices or Users

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/notify

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

{

  "smtpFrom": "Test",

  "to": [

    {

      "deviceId": "1",

      "email": "user@test.com",

      "osFamily": "iOS",

      "serialNumber": "F7NLX6WDF196",

      "smsTo": "+123456676",

      "token": {

        "type": "apns",

        "value": "dfb2fb351a4fb068e40858ecad572e317e6c39b4fa7de6fb29ea1ad7e2254499"

      }

    }

  ],

  "smtpSubject": "This is test subject",

  "smtpMessage": "This is test message",

  "smsMessage": "This is test message",

  "agentMessage": "This is test message",

  "sendAsBCC": "true",

  "smtp": "true",

  "sms": "true",

  "agent": "true",

  "templateId": "-1",

  "agentCustomProps": {

    "sound": "Casino.wav"

  }

応答例 コピー

{

  "status": 0,

  "message": "string",

  "notificationRequests": {

    "smtpNotifRequestId": 0,

    "smsNotifRequestId": 0,

    "smsGatewayNotifRequestId": 0,

    "apnsAgentNotifRequestId": 0,

    "shtpAgentNotifRequestId": 0

  }

}

Authorize a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/authorize

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apply Activation Lock Bypass on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/activationLockBypass

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apply App Lock on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/appLock

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apply App Wipe on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/appWipe

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apply Container Lock on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/containerLock

クエリパラメーター:newPinCode – AndroidコンテナーのPINコード

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Container Lock on a List of Devices

URL: https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/containerLock/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apply Container Unlock on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/containerUnlock

クエリパラメーター:newPinCode – AndroidコンテナーのPINコード

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Container Unlock on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/containerUnlock/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Reset Container Password on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/containerPwdReset

クエリパラメーター:newPinCode – AndroidコンテナーのPINコード

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Reset Container Password on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/containerPwdReset/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Disown a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/disown

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Locate a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/locate

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Locate a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/locate/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apply GPS Tracking on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/track

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel GPS Tracking on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/track/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Lock a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/lock

クエリパラメーター: 

newPinCode – AndroidおよびSymbianデバイスのPINコードは4~16文字にする必要があります。 WondowsデバイスのPINコードは4桁にする必要があります。
resetPinCode – ロックリクエストにPINコードのリセットリクエストを追加します。 Windows Phone 8.1でのみ使用できます。
lockMessage – ロックリクエストにメッセージを追加します。 iOS 7以降でのみ使用できます。
phoneNumber – ロックリクエストに電話番号を追加します。 iOS 7以降でのみ使用できます。

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Lock of a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/lock/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Unlock a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/unlock

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Unlock of a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/unlock/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Deploy a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/refresh

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Request AirPlay Mirroring on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/requestMirroring

クエリパラメーター

dstName – 宛先名(宛先名または宛先デバイスIDのいずれか)
dstDevId – 宛先デバイスのMACアドレス(宛先名または宛先デバイスIDのいずれか)
scanTime – スキャンする間隔(秒)
screenSharingPwd – 画面共有のパスワード

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Request for AirPlay Mirroring on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/requestMirroring/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Stop AirPlay Mirroring on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/stopMirroring

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Stop AirPlay Mirroring on a List of Devcies

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/stopMirroring/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Clear All Restrictions on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/restrictions/clear

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Clear All Restrictions on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/restrictions/clear/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Revoke a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/revoke

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Ring a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/ring

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Ringing a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/ring/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Wipe a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/wipe

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Wipe of a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/wipe/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Selectively Wipe a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/selwipe

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Selectively Wiping a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/selwipe/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Wipe the SD Cards on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/sdcardwipe

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancel Wiping SD Cards on a List of Devices

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/sdcardwipe/cancel

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

[1,2]

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Get All Known Properties on a Device

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/knownProperties

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "knownProperties": {

    "knownProperties": {

      "knownPropertyList": [

       {

          "name": "string",

          "type": "STRING",

          "displayName": "string",

          "group": "EVERYWAN",

          "groupLabel": "string"

        }

      ]

   }

}

Get All Used Properties on a Device

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/usedProperties

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceUsedPropertiesList": {

    "deviceUsedProperties": {

      "deviceUsedPropertiesParameters": [

        {

          "name": "string",

          "type": "STRING",

          "displayName": "string"

        }

      ]

    }

  }

}

Get All Device Properties by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/properties/{deviceId}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "devicePropertiesList": {

    "deviceProperties": {

      "startIndex": 0,

      "devicePropertyParameters": [

        {

          "name": "string",

          "value": "string",

          "id": 0,

          "displayName": "string",

          "group": "string",

          "b64": true

        }

      ],

      "totalCount": 0

    }

  }

}

Update All Device Properties by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/properties/{deviceId}

リクエストの種類:PUT

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

{

    "properties": [

        {

            "name": "ACTIVE_ITUNES",

            "value": "0"

        }

    ]

}

応答例 コピー

{

  "status": 0,

  "message": "string"

}

Add or Update a Device Property by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/properties/{deviceId}

リクエストの種類:POST

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

リクエスト例 コピー

{

  "name": "PROPERTY_NAME",

  "value": "PROPERTY_VALUE"

}

応答例 コピー

{

  "status": 0,

  "message": "string"

}

Delete a Device Property by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/properties/{deviceId}

リクエストの種類:DELETE

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string"

}

Get iOS Device MDM Status by Device ID

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/mdmStatus/{deviceId}

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "deviceMdmStatus": {

    "deviceMdmStatusParameters": {

         "pushState": "ENQUEUED",

         "lastPushDate": 0,

         "lastRepliedNotification": 0,

         "lastSentNotification": 0,

         "pushStateLabel": "string"

      }

  }

}

Generate PIN code

URL:https://<ホスト名>:<ポート番号>/xenmobile/api/v1/device/pincode/generate

クエリパラメーター:pinCodeLength – 要求したPINコードの長さ 

リクエストの種類:GET

リクエストヘッダー:auth_token – ユーザーのログオン時に取得される認証トークン

                               Content type – application/json

応答例 コピー

{

  "status": 0,

  "message": "string",

  "pinCode": {

    "answer": "string"

  }

}