Product Documentation

API REST XenMobile : références

Jul 25, 2016

Vous pouvez appeler les services REST à l'aide de n'importe quel client REST et l'API REST de XenMobile pour appeler les services qui sont exposés au travers de la console XenMobile. L'API n'exige pas de connexion à la console XenMobile pour appeler les services décrits dans cet article.

Vous devez utiliser l'une des autorisations suivantes pour accéder à l'API REST :

  • Autorisation d'accès à l'API publique définie dans le cadre de la configuration d'accès basé sur un rôle (pour plus d'informations sur la configuration d'accès basé sur un rôle, consultez la section Configuration de rôles avec RBAC)
  • Autorisation de super utilisateur

Vous pouvez appeler les services d'API REST à l'aide d’un client REST.

Pour appeler les services D'API REST

Les éléments ci-dessous sont des exemples illustrant comment appeler l'API REST à l'aide de chacune des méthodes précédentes.

Remarque

dans les exemples suivants, modifiez le nom de l'hôte et le numéro de port afin qu'ils correspondent à votre environnement.

À l'aide d'un client REST

Cet exemple utilise le client Advanced REST pour Chrome.

Connexion

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

Requête : { "login":"administrator", "password":"password" }

Type de méthode : POST

Content-type : application/json

localized image

Obtenir les groupes de mise à disposition par filtre

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

Requête Copier

{

        "start": 1,

        "sortOrder": "DESC",

        "deliveryGroupSortColumn":"id",

        "search":"add"

}

Type de méthode : POST

Content-type : application/json

localized image

Services de l'API REST publique

Le tableau suivant répertorie les services REST disponibles :

Fonction

Service REST

URL

Connexion

Connexion

/xenmobile/api/v1/authentication/login

 

Déconnexion

/xenmobile/api/v1/authentication/logout

Certificats

Obtenir tous les certificats

xenmobile/api/v1/certificates

 

Supprimer les certificats

xenmobile/api/v1/certificates/

 

Importer le certificat en tant que SAML

xenmobile/api/v1/certificates/import/certificate/saml

 

Importer le certificat en tant que serveur

xenmobile/api/v1/certificates/import/certificate/server

 

Importer le certificat en tant qu'écouteur

xenmobile/api/v1/certificates/import/certificate/listener

 

Créer un certificat

xenmobile/api/v1/certificates/csr

 

Exporter un certificat

xenmobile/api/v1/certificates/export

Keystore

Importer le keystore en tant que serveur

xenmobile/api/v1/certificates /import/keystore/server

 

Importer le keystore en tant qu'SAML

xenmobile/api/v1/certificates /import/ keystore/saml

 

Importer le keystore en tant qu'APNS

xenmobile/api/v1/certificates /import/ keystore/apns

 

Importer le keystore en tant qu'écouteur

xenmobile/api/v1/certificates /import/ keystore/listener

Licences

Obtenir les informations de licence

xenmobile/api/v1/licenses

 

Enregistrer les informations de licence

xenmobile/api/v1/licenses

 

Charger des licences

xenmobile/api/v1/licenses/upload

 

Supprimer des licences

xenmobile/api/v1/licenses/remove

 

Activer une licence

xenmobile/api/v1/licenses/activate/{licenseType}

 

Tester le serveur

xenmobile/api/v1/licenses/testserver

 

Obtenir la date d'expiration

xenmobile/api/v1/licenses/getexpirationdate

LDAP

Obtenir la liste de configuration LDAP

xenmobile/api/v1/ldap

 

Ajouter un nouveau protocole LDAP

xenmobile/api/v1/ldap/msactivedirectory

 

Modifier un nouveau protocole LDAP

xenmobile/api/v1/ldap/msactivedirectory/{name}

 

Définir la configuration LDAP par défaut

xenmobile/api/v1/ldap/default/{name}

 

Supprimer LDAP

configxenmobile/api/v1/ldap/{name}

NetScaler

Obtenir NetScaler Gateway

xenmobile/api/v1/netscaler

 

Ajouter NetScaler Gateway

xenmobile/api/v1/netscaler

 

Mettre à jour NetScaler Gateway

xenmobile/api/v1/netscaler/{id}

 

Définir NetScaler Gateway par défaut

xenmobile/api/v1/netscaler/default/{id}

 

Supprimer des NetScaler Gateway

xenmobile/api/v1/netscaler

Notification

Obtenir les serveurs de notification

xenmobile/api/v1/notificationserver

 

Obtenir le serveur de notification par ID

xenmobile/api/v1/notificationserver/{id}

 

Ajouter/modifier un serveur SMTP

xenmobile/api/v1/notificationserver/smtp

 

Ajouter/modifier une passerelle SMS

xenmobile/api/v1/notificationserver/sms

 

Définir le serveur SMTP comme valeur par défaut (activation)

xenmobile/api/v1/notificationserver/activate/smtp/{id}

 

Supprimer un serveur de notification

xenmobile/api/v1/notificationserver/{id}

 

Définir la passerelle SMS comme valeur par défaut (activation)

xenmobile/api/v1/notificationserver/activate/sms/{id}

Utilisateurs et groupes locaux

Obtenir des utilisateurs locaux

xenmobile/api/v1/localusersgroups

 

Obtenir un utilisateur spécifique

xenmobile/api/v1/localusersgroups/{name}

 

Ajouter un utilisateur

xenmobile/api/v1/localusersgroups

 

Importer un fichier de provisioning

xenmobile/api/v1/localusersgroups/importprovisioningfile

 

Mettre à jour un utilisateur

xenmobile/api/v1/localusersgroups

 

Supprimer des utilisateurs

xenmobile/api/v1/localusersgroups/deletelocalusers

 

Supprimer un utilisateur

xenmobile/api/v1/localusersgroups/{name}

 

Obtenir des utilisateurs locaux par filtre

xenmobile/api/v1/localusersgroups/filter

 

Réinitialiser le mot de passe de l'utilisateur

xenmobile/api/v1/localusersgroups/password

Gestion des applications

Supprimer un conteneur d'applications

xenmobile/api/v1/application/{id conteneur}

 

Supprimer des conteneurs d'applications

xenmobile/api/v1/application

 

Obtenir les conteneurs d'applications par filtre

xenmobile/api/v1/application/filter

 

Obtenir le conteneur d'applications Weblink par ID de conteneur

xenmobile/api/v1/application/weblink/{container id}

 

Obtenir le conteneur d'applications Web et SaaS par ID de conteneur

xenmobile/api/v1/application/saas/{id conteneur}

 

Obtenir le conteneur d'applications Appstore par ID de conteneur

xenmobile/api/v1/application/appstore/{id conteneur}

 

Obtenir le conteneur d'applications mobiles par ID de conteneur

xenmobile/api/v1/application/mobile/{id conteneur}

Groupes de mise à disposition

Ajouter des groupes de mise à disposition

xenmobile/api/v1/deliverygroups

 

Modifier des groupes de mise à disposition

xenmobile/api/v1/deliverygroups

 

Obtenir un groupe de mise à disposition spécifique

xenmobile/api/v1/deliverygroups/{nom du rôle}

 

Obtenir les groupes de mise à disposition par filtre

xenmobile/api/v1/deliverygroups/filter

 

Obtenir tous les groupes de mise à disposition

xenmobile/api/v1/deliverygroups

 

Supprimer des groupes de mise à disposition

xenmobile/api/v1/deliverygroups

 

Obtenir l'état du déploiement

xenmobile/api/v1/deliverygroups/getdeploymentstatus/{nom}

Propriétés du serveur

Obtenir les propriétés du serveur

xenmobile/api/v1/serverproperties/

 

Obtenir les propriétés du serveur par filtre

xenmobile/api/v1/serverproperties/filter/

 

Ajouter des propriétés de serveur

xenmobile/api/v1/serverproperties/

 

Modifier les propriétés de serveur

xenmobile/api/v1/serverproperties/

 

Réinitialiser les propriétés de serveur

xenmobile/api/v1/serverproperties/reset

 

Supprimer les propriétés de serveur

xenmobile/api/v1/serverproperties/

Définition des API REST

Les sections suivantes décrivent les API répertoriées dans le tableau précédent.

Rappel : dans les exemples suivants, modifiez le nom de l'hôte et le numéro de port afin qu'ils correspondent à votre environnement.

Pour ouvrir une session sur l'API publique

Accepte les informations d'identification de l'utilisateur et utilise l'AuthenticationManager existant pour authentifier l'utilisateur. La première fois que AuthenticationManager authentifie un utilisateur, il génère un jeton d'authentification qui est placé dans l'en-tête de la requête.

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

Type de requête : POST

Paramètres de requête Copier

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

Exemple de réponse Copier

{

      "auth-token":"q483409eu82mkfrcdiv90iv0gc:q483409eu82mkfrcdiv90iv0gc"

}

Pour se déconnecter de l'API publique

Supprime le jeton d'authentification émis lorsque l'utilisateur se connecte et déconnecte l'utilisateur actuel. Nécessite le nom d'utilisateur et le jeton d'authentification.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

Paramètres de requête Copier

{“login”:”administrator”}

Exemple de réponse Copier

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

Pour gérer les certificats

Les opérations de gestion des certificats vous permettent d'afficher, de supprimer, d'importer et d'ajouter des certificats via l'API publique.

Obtenir tous les certificats

Retourne tous les certificats dans la base de données.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

Paramètres de requête : None

Exemple de réponse Copier

 

{

      "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

      }

}

 

Supprimer les certificats

Supprime les certificats spécifiés. Requiert l'ID du certificat pour chaque certificat à supprimer.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

Paramètres de requête Copier

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

Importer le certificat en tant que certificat SAML

Importe le certificat spécifié en tant que certificat SAML.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

           Content-type : Multipart/form-data

Paramètres de requête Copier

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'saml',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

Exemple de réponse Copier

{

      "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

      }

}

Importer le certificat en tant que certificat de serveur

Importe le certificat spécifié en tant que certificat de serveur.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête Copier

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

Exemple de réponse Copier

{

      "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

      }

}

Importer le certificat en tant que certificat d'écoute

Importe le certificat spécifié en tant que certificat d'écoute SSL.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête Copier

 

certImportData = { 

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'listener',

      'keystoreType':'PKCS12',

      'uploadType':'certificate',

      'description':'test description'

}

uploadFile = <the actual file to be uploaded>

 

Exemple de réponse Copier

{

      "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

      }

}

Créer un certificat

Crée un certificat auto-signé ou une demande de signature de certificat (CSR) qui requiert une signature de l'autorité de certification.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Application/form_url_encoded

Paramètres de requête Copier

{

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

}

Exemple de réponse Copier

{

      status: 0

      message: "Success"

      csrRequest: ""

      apnsCheck: null

      certificate: null

      apnsCheckObj:

      {

      topicNameMismatch: false

      certExpired: false

      certNotYetValid: false

      malformed: false

      }

}

Exporter un certificat

Télécharge le certificat spécifié. Le tableau suivant dresse la liste des paramètres pour cette opération.

Paramètre

Requis

Description

id

Oui

ID du certificat numérique

password

 

Mot de passe associé au certificat exporté.

exportPrivateKey

 

Indicateur qui spécifie si la clé privée doit être exportée.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "id": "300",

      "password": "1111",

      "exportPrivateKey": true

}

Exemple de réponse : affiche la chaîne de certificat suite à une requête fructueuse.

Pour gérer les keystores

Vous pouvez importer des keystores par le biais de l'API publique

Importer un keystore serveur

Importe un keystore serveur.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête Copier

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

      uploadFile = <certificate file>

      uploadFile = <private key file>

Exemple de réponse Copier

{

      "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

      }

}

Importer un keystore SAML

Importe un keystore SAML.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête Copier

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':'none',

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

 }

      uploadFile = <certificate file>

      uploadFile = <private key file>

Exemple de réponse Copier

{

      "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

      }

}

Importer un keystore APNS

Importe un keystore APNS.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête Copier

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':apns,

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

uploadFile = <certificate file>

uploadFile = <private key file>

Exemple de réponse Copier

{

      "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

      }

}

Importer un keystore d'écoute SSL

Importe un keystore d'écoute SSL.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête Copier

certImportData = {

      'type':'cert',

      'checkTopicName':true,

      'password':'1111',

      'alias':'',

      'useAs':”listener”,

      'keystoreType':'PKCS12',

      'uploadType':'keystore',

      'description':'test description'

      }

 uploadFile = <certificate file>

 uploadFile = <private key file>

Exemple de réponse Copier

{

      "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

      }

}

Pour gérer les licences

Vous permet de gérer les licences par le biais de l'API publique.

Obtenir les informations de licences

Affiche des informations sur les licences.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      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"

              }

      }

}

Enregistrer les informations de licences

Enregistre toutes les informations sur les licences.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

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

      }

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success"

}

Charger le fichier de licences

Charge le fichier de licences spécifié.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : Multipart/form-data

Paramètres de requête : uploadFile =

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success"

}

Activer une licence

Active la licence spécifiée.

URL : https://:/xenmobile/api/v1/licenses/activate/{type de licence}

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête : ajoutez le type de licence pour activer l'URL de la licence.

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success"

      "cpLicenseServer": null

}

Supprimer toutes les licences

Supprime toutes les licences.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "isConnected": null

}

Tester le serveur de licences

Vérifie la connectivité sur le serveur de licences.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "serverAddress": "192.0.2.7",

      "localPort": 0,

      "remotePort": 27000,

      "serverType": null,

      "licenseType": null,

      "isServerConfigured": null,

      "gracePeriodLeft": 0,

      "isRestartLpeNeeded": null,

      "isScheduleNotificationNeeded": null,

      "licenseList": [],

      "licenseNotification": null

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "isConnected": true

}

Obtenir la première date d'expiration

Trouve la licence avec la première date d'expiration.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "expiredDate": 1448956800000,

      "daysBeforeExpire": 229,

      "daysInPOC": 0

}

Pour gérer les configurations LDAP

Le tableau suivant dresse la liste des paramètres utilisés dans les opérations de configuration LDAP.

Paramètre

Requis

Description

primaryHost

Oui

Adresse IP du serveur LDAP principal ou nom d'hôte. Entrez en tant qu'Adresse IP ou FQDN.

secondaryHost

Non

Adresse IP du serveur LDAP secondaire ou nom d'hôte. Entrez en tant qu'Adresse IP ou FQDN.

port

Oui

Numéro de port du serveur LDAP

username

Oui

Serveur LDAP valide nom d'utilisateur

password

Oui

Mot de passe pour username

userBaseDN

Oui

 

lockoutLimit

Non

 

lockoutTime

Non

 

useSecure

Non

 

userSearchBy

Oui

Rechercher les utilisateurs par upn ou samaccount

domain

Oui

Nom de domaine unique du serveur LDAP

domainAlias

Oui

Alias pour le domaine LDAP

globalCatalogPort

Non

 

gcRootContext

Non

 

groupBaseDN

Oui

 

isDefault

Non

Partie de la réponse GET qui indique si la configuration LDAP est la configuration par défaut.

name

Non

Partie de la réponse GET qui est un identificateur unique utilisé pour mettre à jour ou supprimer la configuration LDAP.

Répertorier la configuration LDAP

Répertorie la configuration LDAP entière dans XenMobile.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

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

      ]

}

Ajouter une nouvelle configuration LDAP

Ajoute une nouvelle configuration LDAP. Le nom de domaine doit être unique et ne peut pas être le même qu'une autre configuration LDAP.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

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

}

Exemple de réponse Copier

{

      “status”: 0,

      “message”: “LDAP configuration created”

}

Modifier une configuration LDAP

Modifie une configuration LDAP, mais vous ne pouvez pas modifier le domaine avec l'opération de modification.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

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

}

Définir la configuration LDAP par défaut

Définit la configuration LDAP spécifiée en tant que configuration par défaut.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Supprimer une configuration LDAP

Supprime la configuration LDAP spécifiée.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Pour gérer les configurations NetScaler Gateway

Vous permet de gérer les configurations de NetScaler Gateway. Le tableau suivant dresse la liste des paramètres utilisés dans les opérations NetScaler Gateway.

Paramètre

Requis

Description

name

Oui

Nom unique de NetScaler Gateway

alias

Non

 

url

Oui

URL publiquement accessible pour NetScaler Gateway

passwordRequired

Oui

 

logonType

Oui

Valeurs valides : domain-only, domain-token, domain-certificate, certificate-only, certificate-token et token-only

callback

Non

 

default

Oui

Définissez ce paramètre sur true ou false lors de l'ajout ou de la modification d'une configuration de NetScaler Gateway. Si ce paramètre n'est pas transmis, la valeur par défaut est false.

id

Non

Partie de la réponse GET qui est un identificateur unique utilisé pour mettre à jour ou supprimer la configuration NetScaler Gateway.

Répertorier toutes les configurations NetScaler Gateway

Répertorie la configuration NetScaler Gateway entière dans XenMobile.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

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

              }

      ]

}

Ajouter une nouvelle configuration NetScaler Gateway

Ajoute une nouvelle configuration NetScaler Gateway.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name":"displayName",

      "alias":"",

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

      "passwordRequired":"false",

      "logonType":"domain”,

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

      “ip”:”192.0.2.8”}]

}

Modifier une configuration NetScaler Gateway

Modifie la configuration NetScaler Gateway spécifiée.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name":"displayName",

      "alias":"",

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

      "passwordRequired":"false",

      "logonType":"domain”,

      “default”: true,

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

      “ip”:”192.0.2.8”}]

}

Supprimer une configuration NetScaler Gateway

Supprime la configuration NetScaler Gateway spécifiée.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Définir la configuration NetScaler Gateway par défaut

Définit la configuration NetScaler Gateway spécifiée en tant que configuration par défaut.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Pour gérer les configurations du serveur de notifications SMS et SMTP

Vous pouvez ajouter, modifier, activer (définir comme valeur par défaut) et supprimer les configurations du serveur SMS et SMTP. Le tableau suivant dresse la liste des paramètres utilisés dans les opérations de configuration du serveur SMS et SMTP.

Paramètre

Requis

Description

name

Oui

Nom unique de configuration SMS/SMTP.

serverType

Non

Type de serveur de notification (SMS ou SMTP) envoyé par le serveur dans la requête GET.

active

Non

Indique si le serveur est utilisé pour les notifications. Un seul serveur peut être actif pour chaque type.

id

Non

Identificateur unique utilisé pour mettre à jour, supprimer et activer le serveur.

description

Non

Description du serveur.

Paramètres SMS

key

Oui

 

secret

Oui

 

virtualPhoneNumber

Oui

Doit utiliser un format de numéro de téléphone.

https

Oui

La valeur par défaut est false

country

Oui

 

carrierGateway

Oui

La valeur par défaut est false

Paramètres SMTP

secureChannelProtocol

Oui

Type de protocole de sécurité à utiliser. Les valeurs valides sont : None, SSL et TLS. La valeur par défaut est none.

port

Oui

 

authentication

Oui

Indique s'il faut utiliser l'authentification. Les valeurs valides sont true et false.

username

Oui, si l'authentification est true.

 

password

Oui, si l'authentification est true.

 

msSecurePasswordAuth

Oui

La valeur par défaut est false

fromName

Oui

 

fromEmail

Oui

 

numOfRetries

Non

Un nombre entier. La valeur par défaut est 5.

timeout

Non

Un nombre entier. La valeur par défaut est 30.

maxRecipients

Non

Un nombre entier. La valeur par défaut est 100.

Répertorier tous les serveurs SMS et SMTP

Répertorie tous les serveurs SMS et SMTP dans XenMobile.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

                               Accept : application/json

Exemple de réponse Copier

{

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

      ]

}

Obtenir les détails du serveur

Obtient des informations sur le serveur par ID de serveur.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

                               Accept : application/json

Exemple de réponse SMS Copier

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Exemple de réponse SMTP Copier

{

      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

}

Ajouter une configuration de serveur SMS

Ajoute une configuration de serveur SMS.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Modifier la configuration du serveur SMS

Modifie la configuration du serveur SMS spécifié.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name":"displayName",

      "description":"",

      "server":"192.0.2.9",

      "carrierGateway":"true",

      "country":"+93",

      "https":"false”,

      “key”: “123456”,

      "secret":"secretKey",

      "virtualPhoneNumber":"4085552222",

      "carrierGateway":"true"

}

Ajouter une configuration de serveur SMTP

Ajoute une configuration de serveur SMTP.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      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

}

Modifier une configuration SMTP

Modifie la configuration SMTP spécifiée.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      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

}

Supprimer la configuration du serveur

Supprime la configuration du serveur SMS ou SMTP spécifié.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Définir la configuration SMS par défaut

Définit la configuration du serveur SMS spécifié en tant que configuration par défaut.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Définir la configuration SMTP par défaut

Définit la configuration du serveur SMTP spécifié en tant que configuration par défaut.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Pour gérer les utilisateurs et groupes locaux

Vous pouvez gérer les utilisateurs et groupes locaux en utilisant les services suivants.

Obtenir tous les utilisateurs

Obtient tous les utilisateurs locaux.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "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

              }

      ]

}

Obtenir un utilisateur

Obtient l'utilisateur local spécifié.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "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

      }

}

Ajouter un utilisateur

Ajoute un utilisateur avec les attributs spécifiés.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "attributes": {

              "badpwdcount": "4",

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

              "company": "example",

              "mobile": "4695557854"

              },

      "groups": [

              "MSP"

              ],

      "role": "USER",

      "username": "justaname_XX",

      "password": "password"

}

Exemple de réponse Copier

{

      "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

      }

}

Mettre à jour un utilisateur

Met à jour les attributs utilisateur.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "attributes": {

              "badpwdcount": "4",

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

              "company": "example",

              "mobile": "4695557854"

              },

      "groups": [

              "MSP"

              ],

      "role": "USER",

      "username": "justaname_XX",

      "password": "password"

}

Exemple de réponse Copier

{

      "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

      }

}

Changer le mot de passe utilisateur

Réinitialise le mot de passe d'un utilisateur ; vous pouvez également modifier le mot de passe d'un utilisateur dans l'appel « update local user ».

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "username": “administrator”,

      “password”: “newPassword”

}

Exemple de réponse Copier

 

Response Errors:

1250 – User id not found

1252 – Failed to reset the password

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

 

Supprimer des utilisateurs

Supprime les utilisateurs spécifiés.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{ justaname XX }

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "user": null

}

Supprimer un utilisateur

Supprime l'utilisateur spécifié.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "user": null

}

Importer un fichier de provisioning

Charge un fichier contenant les données de l'utilisateur local. Le fichier à charger doit être au format .csv. Pour de plus amples informations sur les fichiers de provisioning, consultez la section Formats des fichiers de provisioning.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

importdata={"fileType:"user"}

uploadfile=<file to be uploaded.csv>

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "user": null

}

Pour gérer les applications

Vous pouvez gérer les applications avec les services suivants.

Obtenir toutes les applications par filtre

Obtient les applications en fonction des paramètres de filtre spécifiés.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "start": 0,

      "limit": 10,

      "orderBy": "name",

      "sortOrder": "desc",

      "searchStr": "justaserver1"

}

Obtenir des applications mobiles par conteneur

Obtient des applications mobiles dans le conteneur spécifié.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "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

      }

}

Obtenir applications SaaS par conteneur

Obtient des applications SaaS à partir du conteneur spécifié.

URL : https://:/xenmobile/api/v1/application/mobile/saas/{Idconteneur}

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Obtenir applications d'un magasin public par conteneur

Obtient les applications d'un magasin public depuis le conteneur spécifié.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Obtenir applications Web Link par conteneur

Obtient des applications Web Link depuis le conteneur spécifié.

URL : https://:/xenmobile/api/v1/application/mobile/weblink/{Idconteneur}

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Supprimer un conteneur d'application

Supprime le conteneur d'application spécifié.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Pour gérer les configurations de groupe de mise à disposition

Vous pouvez gérer les configurations de groupe de mise à disposition avec les services suivants.

Obtenir des groupes de mise à disposition par filtre

Utilise les paramètres de filtre spécifiés pour obtenir les groupes de mise à disposition.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "start": 1,

      "sortOrder": "DESC",

      "deliveryGroupSortColumn": "id",

      “limit”:10,

      "search": "add"

}

Exemple de réponse Copier

{

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

                       }

               ]

        }

}

Obtenir un groupe de mise à disposition par nom

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "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

      }

}

Modifier un groupe de mise à disposition

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name": "add delivery group 2",

      "description": "Changing the description of the delivery group xxx",

      "groups": [

              {

                      "name": "MSP",

                      "uniqueName": "MSP",

                      "uniqueId": "MSP",

                      "domainName": "local"

              },

              {

                      "name":"CN=Users,CN=Builtin,DC=example,DC=com",

                      "uniqueName": "Users",

                      "uniqueId":"a4169204-45f6-48fb-8a0d-847a3200d47e",

                      "domainName": "example.com"

              }

              ],

      "disabled": false,

      "anonymousUser": false,

      "applications": [

              {

                      "name": "GoogleApps_SAML",

                      "required": true

              },

              {

                      "name": "test mdx",

                      "required": false

              }

              ],

      "devicePolicies": [

              {

                      "name":"test terms conditions",

                      "priority":-1

              }

              ],

      "smartActions": [

              {

                      "name":"Smart Action Name 1",

                      "priority":-1

              }

              ],

      "rules": "{\"AND\":[{\"values\":{\"stringOperator\":\"eq\",\"value\":\"justa.name@example.com\"},\"ruleId\":\"001-restrictUserPropEmail\"}]}"

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "role": {

              "id": null,

              "name": "add delivery group 2",

              "description": "Changing the description of the delivery group xxx",

              "groups": [

                      {

                             "id": null,

                             "userListId": null,

                             "name": "MSP",

                             "uniqueName": "MSP",

                             "uniqueId": "MSP",

                             "domainName": "local",

                             "primaryToken": null

                      },

                      {

                             "id": null,

                             "userListId": null,

                             "name": "CN=Users,CN=Builtin,DC=example,DC=com",

                             "uniqueName": "Users",

                             "uniqueId": "a4169204-45f6-48fb-8a0d-847a3200d47e",

                             "domainName": "example.com",

                             "primaryToken": null

                      }

                     ],

              "zoneId": null,

              "zoneDomain": null,

              "rules": "{\"AND\":[{\"values\":{\"stringOperator\":\"eq\",\"value\":\"justa.name@example.com\"},\"ruleId\":\"001-restrictUserPropEmail\"}]}",

              "disabled": false,

              "lastUpdated": null,

              "anonymousUser": false,

              "roledefLangVersionId": null,

              "applications": [

                     {

                      "name": "GoogleApps_SAML",

                             "required": true

                     },

                     {

                             "name": "test mdx",

                             "required": false

                     }

                     ],

              "devicePolicies": [

                     "test terms conditions"

                      ],

              "smartActions": [

                     "justa name"

                     ],

              "nbSuccess": 0,

              "nbFailure": 0,

              "nbPending": 0

      }

}

Ajouter un groupe de mise à disposition

Ajoute un groupe de mise à disposition.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name": "add delivery group 4.0",

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

      "anonymousUser": true,

      "devicePolicies": [

              {

                      "name":"test terms conditions",

                      "priority":-1

              }

              ],

              "applications": [

                      {

                             "name": "GoogleApps_SAML",

                             "required": true

                      },

                      {

                             "name": "Web Link",

                             "required": false

                      }

              ],

      "devicePolicies": [

              {

                      "name":"test terms conditions",

                      "priority":-1

              }

              ],

       "smartActions": [

              {

                      "name":"Smart Action Name 1",

                      "priority":-1

              }

              ],

      "groups": [

              {

                      "uniqueName": "MSP",

                      "domainName": "local",

                      "name": "MSP",

                      "uniqueId": "MSP"

              }

              ],

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

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "role": {

              "id": 16,

              "name": "add delivery group 11.0",

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

              "groups": [

                      {

                             "id": null,

                             "userListId": null,

                             "name": "MSP",

                             "uniqueName": "MSP",

                             "uniqueId": "MSP",

                             "domainName": "local",

                             "primaryToken": null

                      }

                     ],

              "zoneId": null,

              "zoneDomain": null,

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

              "disabled": false,

              "lastUpdated": null,

              "anonymousUser": true,

              "roledefLangVersionId": null,

              "applications": [

                      {

                             "name": "GoogleApps_SAML",

                             "required": true

                      },

                      {

                             "name": "Web Link",

                             "required": false

                      }

                      ],

              "devicePolicies": [

                      "test terms conditions"

                      ],

              "smartActions": [

                      "justa name"

                      ],

              "nbSuccess": 0,

              "nbFailure": 0,

              "nbPending": 0

      }

}

Supprimer un groupe de mise à disposition

Supprime les groupes de mise à disposition spécifiés.

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

[ "add delivery group 11.0" ]

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "roleNames": [

              "add delivery group 11.0"

      ]

}

Pour gérer les propriétés du serveur

Vous pouvez gérer les propriétés du serveur XenMobile à l'aide des services suivants.

Obtenir toutes les propriétés du serveur

Obtient tous les propriétés du serveur XenMobile.

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

Type de requête : GET

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Exemple de réponse Copier

{

      "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

              },

      ]

}

Obtenir les propriétés du serveur par filtre

Obtient les propriétés du serveur à l'aide des paramètres de filtre spécifiés.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "start": 0,

      "limit": 1000,

      "orderBy": "name",

      "sortOrder": "desc",

      "searchStr": "justaserver1"

}

Exemple de réponse Copier

{

      "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

              }

      ]

}

Ajouter une propriété de serveur

Ajoute la propriété de serveur spécifiée.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name": "Key 2",

      "value": "Value 1",

      "displayName": "Display Name 1",

      "description": "Description 1"

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "allEwProperties": null

}

Modifier des propriétés de serveur

Modifie la propriété de serveur spécifiée.

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

Type de requête : PUT

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "name": "Key 2",

      "value": "Value 1",

      "displayName": "Display Name 2",

      "description": "Description 2"

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "user": null

}

Réinitialiser des propriétés de serveur

Réinitialise les propriétés de serveur spécifiées.

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

Type de requête : POST

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "names": [,

              "justaname7"

              ]

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "allEwProperties": null

}

Supprimer des propriétés de serveur

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

Type de requête : DELETE

En-tête de requête : auth_token – le jeton d'authentification obtenu lorsque l'utilisateur s'est connecté

                               Content-type : application/json

Paramètres de requête Copier

{

      "justaname3",

      "justaname4"

}

Exemple de réponse Copier

{

      "status": 0,

      "message": "Success",

      "user": null

}