REST Resource: enterprises.enrollmentTokens

Ressource: EnrollmentToken

Un jeton d'enregistrement

Représentation JSON
{
  "name": string,
  "value": string,
  "duration": string,
  "expirationTimestamp": string,
  "policyName": string,
  "additionalData": string,
  "qrCode": string,
  "oneTimeOnly": boolean,
  "user": {
    object (User)
  },
  "allowPersonalUsage": enum (AllowPersonalUsage)
}
Champs
name

string

Nom du jeton d'enregistrement, généré par le serveur lors de la création, au format enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.

value

string

Valeur du jeton transmis à l'appareil et autorisant son enregistrement. Il s'agit d'un champ en lecture seule généré par le serveur.

duration

string (Duration format)

Durée de validité du jeton d'enregistrement, comprise entre une minute et Durations.MAX_VALUE, soit environ 10 000 ans. Si aucune valeur n'est spécifiée, la durée par défaut est d'une heure. Veuillez noter que si la durée demandée entraîne le dépassement de Timestamps.MAX_VALUE pour la valeur expirationTimestamp, expirationTimestamp est contraint de définir la valeur Timestamps.MAX_VALUE.

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

expirationTimestamp

string (Timestamp format)

Délai d'expiration du jeton. Il s'agit d'un champ en lecture seule généré par le serveur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

policyName

string

Nom de la règle initialement appliquée à l'appareil enregistré, au format enterprises/{enterpriseId}/policies/{policyId}. Si aucune valeur n'est spécifiée, la valeur policyName pour l'utilisateur de l'appareil est appliquée. Si userName n'est pas non plus spécifié, enterprises/{enterpriseId}/policies/default est appliqué par défaut. Lors de la mise à jour de ce champ, vous ne pouvez spécifier que le policyId, à condition que policyId ne contienne aucune barre oblique. Le reste du nom de la règle sera déduit.

additionalData

string

Données arbitraires facultatives associées au jeton d'enregistrement. Il peut s'agir, par exemple, de l'ID d'une unité organisationnelle à laquelle l'appareil est attribué après l'enregistrement. Lorsqu'un appareil est enregistré avec le jeton, ces données sont exposées dans le champ enrollmentTokenData de la ressource Device. Les données ne doivent pas comporter plus de 1 024 caractères. sinon la demande de création échouera.

qrCode

string

Chaîne JSON dont la représentation UTF-8 peut être utilisée pour générer un code QR permettant d'enregistrer un appareil avec ce jeton d'enregistrement. Pour enregistrer un appareil à l'aide de la technologie NFC, l'enregistrement NFC doit contenir une représentation java.util.Properties sérialisée des propriétés dans le fichier JSON.

oneTimeOnly

boolean

Indique si le jeton d'enregistrement est à usage unique. S'il est défini sur "true", un seul appareil peut l'utiliser pour l'enregistrement.

user
(deprecated)

object (User)

Ce champ est obsolète et sa valeur est ignorée.

allowPersonalUsage

enum (AllowPersonalUsage)

Détermine si l'utilisation personnelle est autorisée sur un appareil fourni avec ce jeton d'enregistrement.

Pour les appareils détenus par l'entreprise:

  • Le fait d'autoriser l'utilisation personnelle permet à l'utilisateur de configurer un profil professionnel sur l'appareil.
  • Pour désactiver l'utilisation personnelle, l'utilisateur doit provisionner l'appareil en tant qu'appareil entièrement géré.

Pour les appareils personnels:

  • Le fait d'autoriser l'utilisation personnelle permet à l'utilisateur de configurer un profil professionnel sur l'appareil.
  • La désactivation de l'utilisation personnelle empêchera le provisionnement de l'appareil. L'utilisation personnelle ne peut pas être désactivée sur un appareil personnel.

Méthodes

create

Crée un jeton d'enregistrement pour une entreprise donnée.

delete

Supprime un jeton d'enregistrement.

get

Récupère un jeton d'enregistrement actif et non expiré.

list

Répertorie les jetons d'enregistrement actifs et non expirés pour une entreprise donnée.