Product Documentation

Referência da API REST do XenMobile

Oct 06, 2016

Com a API REST do XenMobile, você pode chamar os serviços que são expostos por meio do console XenMobile. Você pode chamar os serviços REST usando um cliente REST. A API não exige que você faça logon no console XenMobile para chamar os serviços.

Para obter o conjunto completo e atual de APIs disponíveis, baixe o PDF de referência da API REST do XenMobile. Este artigo não inclui o conjunto completo de APIs.

Permissões necessárias para acessar a API REST

Você precisa de uma das seguintes permissões para acessar a API REST:

  • Permissão de acesso à API Pública definido como parte da configuração de acesso baseado em função (para obter mais informações sobre a configuração de acesso baseado em função , consulte Configuração de funções com o RBAC)
  • Permissão de superusuário

Para invocar os serviços da API REST

Você pode chamar os serviços da API REST usando o cliente REST ou comandos CURL. Os exemplos a seguir usam o cliente Advanced REST para Chrome.

Nota

Nos exemplos a seguir, altere o nome de host e o número de porta para corresponder ao seu ambiente.

Login

URL: https://:/xenmobile/api/v1/authentication/login

Solicitação: { “login”:”administrator”, “password”:”password” }

Tipo de método: POST

Tipo de conteúdo: application/json

localized image

Obter Grupos de Entrega por filtro

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

Solicitação Copiar

{

        "start": 1,

        "sortOrder": "DESC",

        "deliveryGroupSortColumn":"id",

        "search":"add"

}

Tipo de método: POST

Tipo de conteúdo: application/json

localized image

Definições da API REST

As seções a seguir cobrem algumas das APIs encontradas no PDF. Consulte o PDF para obter a documentação completa das APIs.

Lembre-se: nos exemplos a seguir, altere o nome de host e o número de porta para corresponder ao seu ambiente.

Para fazer login na API pública

Aceita as credenciais do usuário e usa o AuthenticationManager existente para autenticar o usuário. Na primeira vez que o AuthenticationManager autentica um usuário, ele gera um token de autenticação que é colocado no cabeçalho da solicitação.

URL: https://:4443/xenmobile/api/v1/authentication/login

Tipo de solicitação: POST

Parâmetros de solicitação Copiar

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

Exemplo de resposta Copiar

{

      "auth-token":"q483409eu82mkfrcdiv90iv0gc:q483409eu82mkfrcdiv90iv0gc"

}

Para fazer login na API pública usando CWC

Aceita as credenciais do usuário e usa o AuthenticationManager existente para autenticar o usuário. Na primeira vez que o AuthenticationManager autentica um usuário, ele gera um token de autenticação que é colocado no cabeçalho da solicitação.

URL: https://:/xenmobile/api/v1/authentication/cwclogin

Tipo de solicitação: POST

Cabeçalho de solicitação: Authorization – CWSAuth service=

Parâmetros de solicitação Copiar

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

Exemplo de resposta Copiar

{

      "auth-token":"authentication token"

}

Para sair da API pública

Remove o token de autenticação emitido quando o usuário faz login e logoff do usuário atual. Exige o nome do usuário e o token de autenticação.

URL: https://:/xenmobile/api/v1/authentication/logout

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Parâmetros de solicitação Copiar

{“login”:”administrator”}

Exemplo de resposta Copiar

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

Para gerenciar certificados

Com operações de gerenciamento de certificado, você pode exibir, excluir, importar e adicionar certificados por meio da API pública.

Obter todos os certificados

Retorna todos os certificados no banco de dados.

URL: https://:/xenmobile/api/v1/certificates

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Parâmetros de solicitação: nenhum

Exemplo de resposta Copiar

 

{

      "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

      }

}

 

Excluir certificados

Exclui os certificados especificados. Exige o ID de certificado de cada certificado a ser excluído.

URL: https://:/xenmobile/api/v1/publicapi/certificates

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Parâmetros de solicitação Copiar

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

Importar um certificado como um certificado SAML

Importa o certificado especificado como um certificado SAML.

URL: https://:/xenmobile/api/v1/certificates/import/certificate/saml

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'saml',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

Exemplo de resposta Copiar

{

      "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

      }

}

Importar o certificado como um certificado de servidor

Importa o certificado especificado como um certificado de servidor.

URL: https://:/xenmobile/api/v1/certificates/import/certificate/server

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

Exemplo de resposta Copiar

{

      "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

      }

}

Importar o certificado como um certificado de ouvinte

Importa o certificado especificado como um certificado de ouvinte SSL.

URL: https://:/xenmobile/api/v1/certificates/import/certificate/listener

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

 

certImportData = { 

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'listener',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

 

Exemplo de resposta Copiar

{

      "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

      }

}

Criar um certificado

Cria um certificado autoassinado ou uma solicitação CSR que exige uma assinatura de AC.

URL: https://:/xenmobile/api/v1/certificates/csr

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Application/form_url_encoded

Parâmetros de solicitação Copiar

{

      "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"

}

Exemplo de resposta Copiar

{

      status: 0

      message: "Success"

      csrRequest: ""

      apnsCheck: null

      certificate: null

      apnsCheckObj:

      {

      topicNameMismatch: false

      certExpired: false

      certNotYetValid: false

      malformed: false

      }

}

Exportar certificado

Baixa o certificado especificado. A tabela a seguir lista os parâmetros dessa operação.

Parâmetro

Obrigatório

Descrição

id

Sim

O ID numérico do certificado

password

 

A senha associada ao certificado sendo exportado.

exportPrivateKey

 

O sinalizador que indica se a chave privada deve ser exportada.

URL: https://:/xenmobile/api/v1/certificates/export

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "id": "300",

      "password": "1111",

      "exportPrivateKey": true

}

Exemplo de resposta: exibe a cadeia de caracteres do certificado quando a solicitação é bem-sucedida.

Para gerenciar keystores

Você pode importar keystores por meio da API pública.

Importar um keystore de servidor

Importa um keystore de servidor.

URL: https://:/xenmobile/api/v1/certificates/import/keystore/server

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

      uploadFile = <certificate file>

      uploadFile = <private key file>

Exemplo de resposta Copiar

{

      "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

      }

}

Importar um keystore SAML

Importa um keystore SAML.

URL: https://:/xenmobile/api/v1/certificates/import/keystore/saml

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

 }

      uploadFile = <certificate file>

      uploadFile = <private key file>

Exemplo de resposta Copiar

{

      "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

      }

}

Importar um keystore de APNs

Importa um keystore de APNS.

URL: https://:/xenmobile/api/v1/certificates/import/keystore/apns

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':apns,

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

uploadFile = <certificate file>

uploadFile = <private key file>

Exemplo de resposta Copiar

{

      "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

      }

}

Importar um keystore de ouvinte SSL

Importa um keystore de ouvinte SSL.

URL: https://:/xenmobile/api/v1/certificates/import/keystore/listener

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação Copiar

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':”listener”,

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

 uploadFile = <certificate file>

 uploadFile = <private key file>

Exemplo de resposta Copiar

{

      "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

      }

}

Para gerenciar licenças

Permite gerenciar licenças por meio da API pública.

Obter informações de licença

Lista informações sobre todas as licenças.

URL: https://:/xenmobile/api/v1/licenses

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      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"

              }

      }

}

Salvar informações de licença

Salva todas as informações de licença.

URL: https://:/xenmobile/api/v1/licenses

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "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"

      }

}

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success"

}

Carregar o arquivo de licença

Carrega o arquivo de licença especificado.

URL: https://:/xenmobile/api/v1/licenses/upload

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – Multipart/form-data

Parâmetros de solicitação: uploadFile =

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success"

}

Ativar licença

Ativa a licença especificada.

URL: https://:/xenmobile/api/v1/licenses/activate/{tipo de licença}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação: acrescente o tipo de licença para ativar a URL da licença.

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success"

      "cpLicenseServer": null

}

Remover todas as licenças

Remove todas as licenças.

URL: https://:/xenmobile/api/v1/licenses/remove

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "isConnected": null

}

Testar o servidor de licenças

Realiza uma verificação de conectividade no servidor de licenças.

URL: https://:/xenmobile/api/v1/licenses/testserver/

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "serverAddress": "192.0.2.7",

      "localPort": 0,

      "remotePort": 27000,

      "serverType": null,

      "licenseType": null,

      "isServerConfigured": null,

      "gracePeriodLeft": 0,

      "isRestartLpeNeeded": null,

      "isScheduleNotificationNeeded": null,

      "licenseList": [],

      "licenseNotification": null

}

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "isConnected": true

}

Obter a primeira data de expiração

Localiza a licença com a primeira data de expiração.

URL: https://:/xenmobile/api/v1/licenses/getexpirationdate

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "expiredDate": 1448956800000,

      "daysBeforeExpire": 229,

      "daysInPOC": 0

}

Para gerenciar configurações LDAP

A tabela a seguir lista os parâmetros usados nas operações de configuração LDAP.

Parâmetro

Obrigatório

Descrição

primaryHost

Sim

Endereço IP ou nome de host do servidor LDAP principal. Entrada como endereço IP ou FQDN.

secondaryHost

Não

Endereço IP ou nome de host do servidor LDAP secundário. Entrada como endereço IP ou FQDN.

port

Sim

Número de porta do servidor LDAP

username

Sim

Nome de usuário válido do servidor LDAP

password

Sim

Senha de username

userBaseDN

Sim

 

lockoutLimit

Não

 

lockoutTime

Não

 

useSecure

Não

 

userSearchBy

Sim

Pesquisa de usuários por upn ou samaccount

domain

Sim

Nome exclusivo de domínio do servidor LDAP

domainAlias

Sim

Alias do domínio LDAP

globalCatalogPort

Não

 

gcRootContext

Não

 

groupBaseDN

Sim

 

isDefault

Não

Parte da resposta GET que indica se a configuração LDAP é o padrão.

name

Não

Parte da resposta GET que é um identificador exclusivo usado para atualizar ou excluir a configuração LDAP.

Listar configuração LDAP

Lista a configuração LDAP inteira no XenMobile.

URL: https://:/xenmobile/api/v1/ldap

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      “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 }

      ]

}

Adicionar nova configuração LDAP

Adiciona uma nova configuração LDAP. O nome de domínio deve ser exclusivo e não pode ser igual ao de qualquer outra configuração LDAP.

URL: https://:/xenmobile/api/v1/ldap/msactivedirectory

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "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":""

}

Exemplo de resposta Copiar

{

      “status”: 0,

      “message”: “LDAP configuration created”

}

Editar a configuração LDAP

Edita uma configuração LDAP existente, exceto que você não pode alterar o domínio usando a operação de edição.

URL: https://:/xenmobile/api/v1/ldap/msactivedirectory/{nome}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "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":""

}

Definir a configuração LDAP padrão

Define a configuração LDAP especificada como o padrão.

URL: https://:/xenmobile/api/v1/ldap/default/{nome}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Excluir a configuração LDAP

Exclui a configuração LDAP especificada.

URL: https://:/xenmobile/api/v1/ldap/{nome}

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Para gerenciar as configurações do NetScaler Gateway

Permite gerenciar as configurações do NetScaler Gateway. A tabela a seguir lista os parâmetros usados nas operações do NetScaler Gateway.

Parâmetro

Obrigatório

Descrição

name

Sim

Nome exclusivo do NetScaler Gateway

alias

Não

 

url

Sim

URL acessível publicamente do NetScaler Gateway

passwordRequired

Sim

 

logonType

Sim

Valores válidos: domain-only, domain-token, domain-certificate, certificate-only, certificate-token e token-only

callback

Não

 

default

Sim

Definido como true ou false durante a adição ou a edição de uma configuração do NetScaler Gateway. Se esse parâmetro não for transmitido, o padrão será definido como false.

id

Não

Parte da resposta GET que é um identificador exclusivo usado para atualizar ou excluir a configuração do NetScaler Gateway.

Listar todas as configurações do NetScaler Gateway

Lista a configuração do NetScaler Gateway inteira no XenMobile.

URL: https://:/xenmobile/api/v1/netscaler

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      “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”}]

              }

      ]

}

Adicionar uma nova configuração do NetScaler Gateway

Adiciona uma nova configuração do NetScaler Gateway.

URL: https://:/xenmobile/api/v1/netscaler

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "name":"displayName",

      "alias":"",

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

      "passwordRequired":"false",

      "logonType":"domain”,

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

      “ip”:”192.0.2.8”}]

}

Editar a configuração do NetScaler Gateway

Editar a configuração do NetScaler Gateway especificada.

URL: https://:/xenmobile/api/v1/netscaler/{id}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "name":"displayName",

      "alias":"",

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

      "passwordRequired":"false",

      "logonType":"domain”,

      “default”: true,

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

      “ip”:”192.0.2.8”}]

}

Excluir a configuração do NetScaler Gateway

Excluir a configuração do NetScaler Gateway especificada.

URL: https://:/xenmobile/api/v1/netscaler/{id}

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Definir a configuração padrão do NetScaler Gateway

Definir a configuração do NetScaler Gateway especificada como o padrão.

URL: https://:/xenmobile/api/v1/netscaler/default/{id}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Para gerenciar as configurações de servidor de notificação SMTP e SMS

Você pode adicionar, editar, ativar (definir como padrão) e excluir as configurações de servidor SMS e SMTP. A tabela a seguir lista os parâmetros usados com as operações de configuração de servidor SMS e SMTP.

Parâmetro

Obrigatório

Descrição

name

Sim

Nome exclusivo da configuração SMS/SMTP.

serverType

Não

Tipo de servidor de notificação (SMS ou SMTP) enviado pelo servidor na solicitação GET.

active

Não

Indica se o servidor está sendo usado para notificações. Somente um servidor pode estar ativo para cada tipo.

id

Não

Identificador exclusivo usado para atualizar, excluir ou ativar o servidor.

description

Não

A descrição do servidor.

Parâmetros SMS

key

Sim

 

secret

Sim

 

virtualPhoneNumber

Sim

Deve estar no formato de número de telefone.

https

Sim

O padrão é false.

country

Sim

 

carrierGateway

Sim

O padrão é false.

Parâmetros SMTP

secureChannelProtocol

Sim

O tipo do protocolo de segurança a ser usado. Os valores válidos são: nenhum, SSL e TLS. Padrão é nenhum.

port

Sim

 

authentication

Sim

Se a autenticação deve ser usada. Os valores válidos são true e false.

username

Sim, se a autenticação for true.

 

password

Sim, se a autenticação for true.

 

msSecurePasswordAuth

Sim

O padrão é false.

fromName

Sim

 

fromEmail

Sim

 

numOfRetries

Não

Um inteiro. O padrão é 5.

timeout

Não

Um inteiro. O padrão é 30.

maxRecipients

Não

Um inteiro. O padrão é 100.

Listar todos os servidores SMTP e SMS

Lista todos os servidores SMTP e SMS no XenMobile.

URL: https://:/xenmobile/api/v1/notificationserver

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

                               Aceitar – application/json

Exemplo de resposta Copiar

{

      “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"}

      ]

}

Obter os detalhes do servidor

Obter os detalhes sobre o servidor por ID do servidor.

URL: https://:/xenmobile/api/v1/notificationserver/{id}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

                               Aceitar – application/json

Exemplo de resposta SMS Copiar

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Exemplo de resposta SMTP Copiar

{

      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

}

Adicionar uma configuração de servidor SMS

Adicionar uma configuração de servidor SMS.

URL: https://:/xenmobile/api/v1/notificationserver/sms

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Editar uma configuração de servidor SMS

Editar a configuração de servidor SMS especificada.

URL: https://:/xenmobile/api/v1/notificationserver/sms/{id}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Adicionar uma configuração de servidor SMTP

Adiciona uma configuração de servidor SMTP.

URL: https://:/xenmobile/api/v1/notificationserver/smtp

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      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

}

Editar uma configuração de SMTP

Editar a configuração de SMTP especificada.

URL: https://:/xenmobile/api/v1/notificationserver/smtp/{id}

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      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

}

Excluir a configuração de servidor

Excluir a configuração de servidor SMTP ou SMS especificada.

URL: https://:/xenmobile/api/v1/notificationserver/{id}

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Definir a configuração de SMS padrão

Definir a configuração de servidor SMS especificada como o padrão.

URL: https://:/xenmobile/api/v1/notificationserver/activate/sms/{id}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Definir a configuração de SMTP padrão

Definir a configuração de servidor SMTP especificada como o padrão.

URL: https://:/xenmobile/api/v1/notificationserver/activate/smtp/{id}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Para gerenciar usuários locais e grupos

Você pode gerenciar usuários locais e grupos usando os serviços a seguir.

Obter todos os usuários

Obter todos os usuários locais.

URL: https://:/xenmobile/api/v1/localusersgroups

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "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

              }

      ]

}

Obter um usuário

Obter o usuário local especificado.

URL: https://:/xenmobile/api/v1/localusersgroups/{nome}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "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

      }

}

Adicionar usuário

Adicionar um usuário com os atributos especificados.

URL: https://:/xenmobile/api/v1/localusersgroups

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "attributes": {

              "badpwdcount": "4",

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

              "company": "example",

              "mobile": "4695557854"

              },

      "groups": [

              "MSP"

              ],

      "role": "USER",

      "username": "justaname_XX",

      "password": "password"

}

Exemplo de resposta Copiar

{

      "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

      }

}

Atualizar usuário

Atualizar os atributos de usuário.

URL: https://:/xenmobile/api/v1/localusersgroups

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "attributes": {

              "badpwdcount": "4",

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

              "company": "example",

              "mobile": "4695557854"

              },

      "groups": [

              "MSP"

              ],

      "role": "USER",

      "username": "justaname_XX",

      "password": "password"

}

Exemplo de resposta Copiar

{

      "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

      }

}

Alterar uma senha de usuário

Redefinir a senha de um usuário; você também pode alterar a senha de um usuário na chamada de usuário local de atualização.

URL: https://:/xenmobile/api/v1/localusersgroups/resetpassword

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "username": “administrator”,

      “password”: “newPassword”

}

Exemplo de resposta Copiar

 

Response Errors:

1250 – User id not found

1252 – Failed to reset the password

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

 

Excluir usuários

Excluir os usuários especificados.

URL: https://:/xenmobile/api/v1/localusersgroups/resetpassword

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{ justaname XX }

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "user": null

}

Excluir um usuário

Excluir o usuário especificado.

URL: https://:/xenmobile/api/v1/localusersgroups/

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "user": null

}

Importar arquivo de provisionamento

Carregar um arquivo que contém os dados do usuário local. O arquivo a ser carregado deve estar no formato .csv. Para obter mais informações sobre arquivos de provisionamento, consulte Formatos de arquivo de provisionamento.

URL: https://:/xenmobile/api/v1/localusersgroups/importprovisioningfile

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

importdata={"fileType:"user"}

uploadfile=<file to be uploaded.csv>

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "user": null

}

Para gerenciar aplicativos

Você pode gerenciar aplicativos usando os serviços a seguir.

Obter todos os aplicativos por filtro

Obter aplicativos com base nos parâmetros de filtro especificados.

URL: https://:/xenmobile/api/v1/application/filter

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login
Tipo de conteúdo – application/json

Dados de solicitação de amostra Copiar

 

{

      "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']"

}

 

 

Dados de resposta da amostra Copiar

{

    "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

        }]

    }

}

Obter aplicativos móveis por contêiner

Obter aplicativos móveis no contêiner especificado.

URL: https://:/xenmobile/api/v1/application/mobile/{containerId}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "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

      }

}

Obter aplicativos de loja pública por contêiner

Obter aplicativos de loja pública do contêiner especificado.

URL: https://:/xenmobile/api/v1/application/mobile/appstore/{containerId}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Excluir o contêiner de aplicativo

Excluir o contêiner de aplicativo especificado.

URL: https://:/xenmobile/api/v1/application/{containerId}

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Para gerenciar configurações de grupo de entrega

Você pode gerenciar as configurações de grupo de entrega usando os serviços a seguir.

Obter grupos de entrega por filtro

Usar os parâmetros de filtro especificados para obter grupos de entrega.

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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

{

    "start": 1,

    "sortOrder": "DESC",

    "deliveryGroupSortColumn": "id",

    “limit”:10,

    "search": "add"

}

Exemplo de resposta Copiar

{

         "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

                          }

                 ]

         }

}

Obter grupo de entrega por nome

URL: https://:/xenmobile/api/v1/deliverygroups/{name}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "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

      }

}

Editar grupo de entrega

URL: https://:/xenmobile/api/v1/deliverygroups

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

 

{

    "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\"}}]}"

}

 

Exemplo de resposta Copiar

 

{

         "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 "

                 }]

       }

 

Adicionar grupo de entrega

Adicionar um grupo de entrega.

URL: https://:/xenmobile/api/v1/deliverygroups

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

{

    "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\"}}]}"

}

Exemplo de resposta Copiar

{

         "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 "

                 }]

       }

Excluir grupo de entrega

Excluir os grupos de entrega especificados.

URL: https://:/xenmobile/api/v1/deliverygroups

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

[ "add delivery group 11.0" ]

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "roleNames": [

              "add delivery group 11.0"

      ]

}

Ativar ou desativar um grupo de entrega

Ativar ou desativar os grupos de entrega especificados.

URL: https://:/xenmobile/api/v1/deliverygroups/{nome do grupo de entrega}/{enable/disable}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "roleName": "AllUsers"

}

Gerenciar as propriedades de servidor

Você pode gerenciar as propriedades de servidor do XenMobile usando os serviços a seguir.

Obter todas as propriedades de servidor

Obter todas as propriedades de servidor do XenMobile atuais.

URL: https://:/xenmobile/api/v1/serverproperties

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

      "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

              },

      ]

}

Obter propriedades de servidor por filtro

Obter propriedades de servidor usando os parâmetros de filtro especificados.

URL: https://:/xenmobile/api/v1/serverproperties/filter

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "start": 0,

      "limit": 1000,

      "orderBy": "name",

      "sortOrder": "desc",

      "searchStr": "justaserver1"

}

Exemplo de resposta Copiar

{

      "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

              }

      ]

}

Adicionar uma propriedade de servidor

Adicionar a propriedade de servidor especificada.

URL: https://:/xenmobile/api/v1/serverproperties

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "name": "Key 2",

      "value": "Value 1",

      "displayName": "Display Name 1",

      "description": "Description 1"

}

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "allEwProperties": null

}

Editar propriedades de servidor

Editar a propriedade de servidor especificada.

URL: https://:/xenmobile/api/v1/serverproperties

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "name": "Key 2",

      "value": "Value 1",

      "displayName": "Display Name 2",

      "description": "Description 2"

}

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "user": null

}

Redefinir propriedades de servidor

Redefinir as propriedades de servidor especificadas.

URL: https://:/xenmobile/api/v1/serverproperties/reset

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "names": [,

              "justaname7"

              ]

}

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "allEwProperties": null

}

Excluir propriedades de servidor

URL: https://:/xenmobile/api/v1/serverproperties

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Parâmetros de solicitação Copiar

{

      "justaname3",

      "justaname4"

}

Exemplo de resposta Copiar

{

      "status": 0,

      "message": "Success",

      "user": null

}

Para gerenciar dispositivos

Você pode gerenciar dispositivos no XenMobile usando os serviços a seguir.

Obter dispositivos por filtro

URL: https://:/xenmobile/api/v1/device/filter

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Todos os Parâmetros de Solicitação são opcionais.

Os valores válidos para sortOrder são: DSC, ASC e DESC.

Os valores válidos para sortColumn são: 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 e BULKPROFILESTATUS.

Parâmetros de solicitação Copiar

{

    "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']"

}

Exemplo de resposta Copiar

{

    "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"

}

Obter dispositivos por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/{device_id}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "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"

      }

    ]

  }

}

Obter aplicativos de dispositivo por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/{device_id}/apps

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deliveryGroups": [

    {

      "statusLabel": "string",

      "linkey": "string",

      "lastUpdate": 0,

      "status": "SUCCESS",

      "name": "string"

    }

  ]

}

Obter o inventário de software gerenciado por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/{device_id}/managedswinventory

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "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

    }

  ]

}

Obter políticas por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/{device_id}/policies

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "policies": [

    {

      "resourceType": "APP_NATIVE",

      "resourceTypeLabel": "string",

      "packageInfo": "string",

      "statusLabel": "string",

      "lastUpdate": 0,

      "status": "SUCCESS",

      "name": "string"

    }

  ]

}

Obter o inventário de software por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/{device_id}/softwareinventory

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "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

    }

  ]

}

Obter coordenadas GPS por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/locations/{device_id}

Parâmetros de consulta:

startDate – a data de início do filtro de coordenadas
endDate – a data de término do filtro de coordenadas

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceCoordinates": {

    "deviceCoordinateList": {

      "deviceCoordinateList": [

        {

          "gpsTimestamp": 0

        }

      ],

      "startDate": 0,

      "endDate": 0

   }

}

Enviar notificação para uma lista de dispositivos ou usuários

URL: https://:/xenmobile/api/v1/device/notify

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

{

  "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"

  }

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Aplicar a opção Bloqueio de contêiner a uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/containerLock

Parâmetros de consulta: newPinCode – o código PIN do contêiner Android

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Aplicar a opção Desbloqueio de Contêiner a uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/containerUnlock

Parâmetros de consulta: newPinCode – o código PIN do contêiner Android

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Parâmetros de consulta: newPinCode – o código PIN do contêiner Android

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar a redefinição de senha do contêiner em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/containerPwdReset/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar a localização de uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/locate/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Aplicar o acompanhamento de GPS em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/track

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar o acompanhamento de GPS em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/track/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Parâmetros de consulta:

newPinCode - o código PIN deve ter entre 4 e 16 caracteres para os dispositivos Android e Symbian. O código PIN deve ter 4 dígitos para os dispositivos Windows
resetPinCode - adicionar uma solicitação de código PIN de redefinição à solicitação de bloqueio. Disponível somente para Windows Phone 8.1
lockMessage - adicionar uma mensagem à solicitação de bloqueio. Disponível somente para o iOS 7 e versões posteriores
phoneNumber - adicionar um número de telefone à solicitação de bloqueio. Disponível somente para o iOS 7 e versões posteriores

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar o bloqueio de uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/lock/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar o desbloqueio de uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/unlock/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Solicitar espelhamento de AirPlay em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/requestMirroring

Parâmetros de consulta:

dstName - o nome de destino, como o nome de destino ou o ID de dispositivo de destino
dstDevId - o endereço MAC do dispositivo de destino, como o nome de destino ou o ID de dispositivo de destino
scanTime - o número de segundos durante os quais verificar
screenSharingPwd - a senha do compartilhamento de tela

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar a solicitação de espelhamento de AirPlay em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/requestMirroring/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar a interrupção do espelhamento de AirPlay em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/stopMirroring/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Limpar todas as restrições em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/restrictions/clear

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar a limpeza de todas as restrições em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/restrictions/clear/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Chamar uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/ring

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar a chamada de uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/ring/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "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

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar o apagamento de uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/wipe/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apagar seletivamente uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/selwipe

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar o apagamento seletivo de uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/selwipe/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Apagar os cartões SD em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/sdcardwipe

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Cancelar o apagamento dos cartões SD em uma lista de dispositivos

URL: https://:/xenmobile/api/v1/device/sdcardwipe/cancel

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

[1,2]

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceActionMessages": {

    "devicesActionParameters": {

      "description": "string",

      "messageList": [

        {

          "id": "string",

          "message": "string"

        }

      ]

    }

  }

}

Obter todas as propriedades conhecidas em um dispositivo

URL: https://:/xenmobile/api/v1/device/knownProperties

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "knownProperties": {

    "knownProperties": {

      "knownPropertyList": [

       {

          "name": "string",

          "type": "STRING",

          "displayName": "string",

          "group": "EVERYWAN",

          "groupLabel": "string"

        }

      ]

   }

}

Obter todas as propriedades usadas em um dispositivo

URL: https://:/xenmobile/api/v1/device/usedProperties

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "deviceUsedPropertiesList": {

    "deviceUsedProperties": {

      "deviceUsedPropertiesParameters": [

        {

          "name": "string",

          "type": "STRING",

          "displayName": "string"

        }

      ]

    }

  }

}

Obter todas as propriedades de dispositivo por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/properties/{deviceId}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "devicePropertiesList": {

    "deviceProperties": {

      "startIndex": 0,

      "devicePropertyParameters": [

        {

          "name": "string",

          "value": "string",

          "id": 0,

          "displayName": "string",

          "group": "string",

          "b64": true

        }

      ],

      "totalCount": 0

    }

  }

}

Atualizar todas as propriedades de dispositivo por ID de dispositivo

URL: https://:/xenmobile/api/v1/device/properties/{deviceId}

Tipo de solicitação: PUT

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

{

    "properties": [

        {

            "name": "ACTIVE_ITUNES",

            "value": "0"

        }

    ]

}

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string"

}

Add or Update a Device Property by Device ID

URL: https://:/xenmobile/api/v1/device/properties/{deviceId}

Tipo de solicitação: POST

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Solicitação de exemplo Copiar

{

  "name": "PROPERTY_NAME",

  "value": "PROPERTY_VALUE"

}

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string"

}

Delete a Device Property by Device ID

URL: https://:/xenmobile/api/v1/device/properties/{deviceId}

Tipo de solicitação: DELETE

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string"

}

Obter o status MDM de um dispositivo iOS por ID do dispositivo

URL: https://:/xenmobile/api/v1/device/mdmStatus/{deviceId}

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "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

Parâmetros de consulta: pinCodeLength – o comprimento do código PIN solicitado

Tipo de solicitação: GET

Cabeçalho de solicitação: auth_token – o token de autenticação obtido quando o usuário fez login

Tipo de conteúdo – application/json

Exemplo de resposta Copiar

{

  "status": 0,

  "message": "string",

  "pinCode": {

    "answer": "string"

  }

}