Création du client

Selon le type de client que vous spécifiez lors de l'appel de la méthode API REST, les actions suivantes peuvent être effectuées :

• Pour un client de type "complet ":
  • Ajouter des informations client à la base de données du Serveur d'intégration.
  • Créer la structure de protection du client dans Kaspersky Security Center (Serveur d'administration virtuel, compte de connexion à celui-ci, structure des dossiers et des groupes d'administration, stratégies d'activation et de désactivation de la protection).
  • Ajouter les informations sur le Serveur d'administration virtuel client dans la base de données du Serveur d'intégration.
• Pour un client de type "simplifié" : ajoutez der informations client dans la base de données du Serveur d'intégration.

Méthode :

POST /api/2.0/virtualization/tenants

Dans le corps de la demande, vous devez spécifier les paramètres suivants :

<tenant>

<name>{titre}</name>

<description>{description}</description>

<userData><![CDATA[{informations supplémentaires}]]></userData>

<preferredViisAddress>{adresse IP}</preferredViisAddress>

<type>{type de client}</type>

<!-- Les informations dans la section vKsc ne sont indiquées que pour le client de type "complet" -->

<vKsc>

<user>

<name>{nom de l'administrateur}</name>

<password>{mot de passe de l'administrateur}</password>

</user>

</vKsc>

</tenant>

où :

• {nom} : nom du client (paramètre requis).
• {description} : description du client (paramètre facultatif).
• {informations supplémentaires} : informations supplémentaires sur le client (paramètre facultatif).
• {adresse IP} : adresse IP du Serveur d'intégration auquel les Light Agents installés sur les machines virtuelles du client doivent se connecter (paramètre facultatif). L'adresse spécifiée est utilisée par défaut lors de la création d'une stratégie pour le Light Agent. Si le paramètre n'est pas spécifié, la stratégie utilise l'adresse IP du Serveur d'intégration de la demande à l'API REST.
• {type de client} - type de client : "complet" ( Complete ) ou "simplifié" ( Simple ) (paramètre requis).
• {nom de l'administrateur} : nom du compte administrateur pour la connexion au Serveur d'administration virtuel du client (paramètre requis lors de la création d'un client de type "complet"). Un compte est créé automatiquement durant la procédure.
• {mot de passe de l'administrateur} : mot de passe du compte administrateur encodé avec la méthode Base64 (paramètre requis lors de la création d'un client de type "complet").

La demande est exécutée de manière asynchrone, l'API REST renvoie un identifiant de tâche de type CreateTenant. À l'aide de la tâche, vous pouvez surveiller la progression de la procédure de création du client. Une fois la tâche terminée, le champ result contient des informations sur le client, y compris l'identifiant du client créé ou des informations sur l'erreur. En cas d'erreur à l'une des étapes de la procédure, toutes les modifications apportées sont restaurées.

Codes de retour :

• 202 (Accepted) : la demande est acceptée. La réponse renvoie un identifiant de tâche de type CreateTenant.
• 400 (Bad request) VIRMT_MandatoryParameterIsNotSpecified : l'un des paramètres requis n'est pas spécifié dans le corps de la demande, par exemple, le nom du client.
• 400 (Bad request) VIRMT_InvalidTenantType : un type de client incorrect est spécifié dans le corps de la demande, le type indiqué n'existe pas.
• 400 (Bad request) VIRMT_VKscCredentialsNotSpecified : le nom ou le mot de passe du compte administrateur du Serveur d'administration virtuel Kaspersky Security Center n'est pas spécifié (lors de la création d'un client de type "complet").
• 400 (Bad request) VIRMT_InvalidViisAddressFormat : format de l'adresse IP du Serveur d'intégration incorrect.
• 403 (Forbidden) : l'accès à la ressource est refusé.

Codes d'erreur possibles dans la tâche :

• KSC_ServiceNotConfigured : les paramètres de connexion à Kaspersky Security Center ne sont pas spécifiés.
• VIRMT_TenantGroupAlreadyExists : un dossier avec un nom correspondant au nom de client spécifié existe déjà dans Kaspersky Security Center.
• VIRMT_TenantWithSpecifiedNameAlreadyExists : un client portant le nom spécifié existe déjà dans la base de données du Serveur d'intégration.
• VIRMT_PasswordNotComplyPolicy : impossible de créer un compte administrateur pour le Serveur d'administration virtuel de Kaspersky Security Center : le mot de passe spécifié ne répond pas aux exigences de mot de passe de Kaspersky Security Center.
• VIRMT_UserWithSpecifiedNameAlreadyExists : impossible de créer un compte administrateur pour le Serveur d'administration virtuel Kaspersky Security Center : un utilisateur portant le même nom existe déjà dans Kaspersky Security Center.

Haut de page