REST Resource: customers.configurations

Ressource: Configuration

Une configuration collecte les options de provisionnement pour les appareils Android. Chaque configuration comprend les éléments suivants :

  • Outil de contrôle des règles relatives aux appareils (DPC) EMM installé sur les appareils
  • Règles EMM appliquées aux appareils.
  • Métadonnées affichées sur l'appareil pour aider les utilisateurs pendant la configuration.

Les clients peuvent ajouter autant de configurations qu'ils le souhaitent. Toutefois, l'enregistrement sans contact fonctionne mieux lorsqu'un client définit une configuration par défaut qui est appliquée à tous les nouveaux appareils achetés par l'entreprise.

Représentation JSON 
{
  "name": string,
  "configurationId": string,
  "configurationName": string,
  "dpcResourcePath": string,
  "dpcExtras": string,
  "companyName": string,
  "contactEmail": string,
  "contactPhone": string,
  "customMessage": string,
  "isDefault": boolean,
  "forcedResetTime": string
}
Champs
name

string

Uniquement en sortie. Nom de ressource de l'API au format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Attribué par le serveur.
configurationId

string (int64 format)

Uniquement en sortie. ID de la configuration. Attribué par le serveur.
configurationName

string

Obligatoire. Nom court décrivant l'objectif de la configuration. Par exemple : Équipe de vente ou Travailleurs intérimaires. Ce nom est visible par les administrateurs informatiques sur le portail d'enregistrement sans contact.
dpcResourcePath

string

Obligatoire. Nom de ressource du DPC (outil de contrôle des règles relatives aux appareils) sélectionné au format customers/[CUSTOMER_ID]/dpcs/*. Pour répertorier les DPC compatibles, appelez customers.dpcs.list.
dpcExtras

string

Extras de provisionnement EMM au format JSON transmis à l'outil DPC.
companyName

string

Obligatoire. Nom de l'organisme. L'enregistrement sans contact affiche ce nom aux utilisateurs lors de la préparation des appareils.
contactEmail

string

Obligatoire. Adresse e-mail à laquelle les utilisateurs de l'appareil peuvent contacter pour obtenir de l'aide. L'inscription sans contact présente cette adresse e-mail aux utilisateurs des appareils avant la phase de préparation. La valeur est validée à la saisie.
contactPhone

string

Obligatoire. Numéro de téléphone que les utilisateurs peuvent composer depuis un autre appareil pour obtenir de l'aide. L'enregistrement sans contact présente ce nombre aux utilisateurs des appareils avant la phase de préparation. Accepte les chiffres, les espaces, le signe plus, les traits d'union et les parenthèses.
customMessage

string

Message, en une ou deux phrases, pour aider les utilisateurs d'appareils à obtenir de l'aide ou leur donner plus de détails sur ce qu'il advient de leur appareil. L'enregistrement sans contact affiche ce message avant la préparation de l'appareil.
isDefault

boolean

Obligatoire. Indique s'il s'agit de la configuration par défaut que l'enregistrement sans contact s'appliquera à tous les nouveaux appareils achetés par l'entreprise par la suite. Vous ne pouvez utiliser qu'une seule configuration client par défaut. Définir cette valeur sur true remplace la valeur isDefault de la configuration par défaut précédente par false.
forcedResetTime

string (Duration format)

Facultatif. Délai avant expiration avant la réinitialisation forcée de l'appareil s'il ne passe pas à l'étape de provisionnement dans l'assistant de configuration, généralement en raison d'une connexion réseau insuffisante pendant l'assistant de configuration. Cette valeur est comprise entre 0 et 6 heures, 2 heures étant la valeur par défaut si elle n'est pas configurée.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

Méthodes

create

 Crée une configuration.

delete

 Supprime une configuration inutilisée.

get

 Récupère les détails d'une configuration.

list

 Liste les configurations d'un client.

patch

 Met à jour les valeurs des champs d'une configuration.