REST Resource: enterprises.enrollmentTokens

Ressource: EnrollmentToken

Un jeton d'inscription.

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 transmise à l'appareil et qui l'autorise à s'enregistrer. 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 (environ 10 000 ans). Si aucune valeur n'est spécifiée, la durée par défaut est de 1 heure. Notez que si la durée demandée entraîne un expirationTimestamp supérieur à Timestamps.MAX_VALUE, expirationTimestamp est forcé à 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 ce champ n'est pas spécifié, l'policyName de l'utilisateur de l'appareil est appliqué. Si userName n'est pas spécifié non plus, enterprises/{enterpriseId}/policies/default est appliqué par défaut. Lorsque vous mettez à jour ce champ, vous ne pouvez spécifier que l'policyId, à condition qu'il ne contienne pas de barre oblique.policyId Le reste du nom de la règle sera inféré.

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. Une fois qu'un appareil s'est inscrit 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 requête 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. Si l'indicateur 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 provisionné avec ce jeton d'enregistrement.

Pour les appareils détenus par l'entreprise:

  • L'activation de 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:

  • L'activation de l'utilisation personnelle permet à l'utilisateur de configurer un profil professionnel sur l'appareil.
  • Si vous désactivez l'utilisation personnelle, l'appareil ne sera pas provisionné. L'utilisation personnelle ne peut pas être désactivée sur un appareil personnel.

Méthodes

create

Crée un jeton d'inscription 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 d'une entreprise donnée.