REST Resource: enterprises.enrollmentTokens

Ressource: EnrollmentToken

Ein Registrierungstoken.

JSON-Darstellung
{
  "name": string,
  "value": string,
  "duration": string,
  "expirationTimestamp": string,
  "policyName": string,
  "additionalData": string,
  "qrCode": string,
  "oneTimeOnly": boolean,
  "user": {
    object (User)
  },
  "allowPersonalUsage": enum (AllowPersonalUsage)
}
Felder
name

string

Der Name des Registrierungstokens, der während der Erstellung vom Server generiert wird, im Format enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.

value

string

Der Tokenwert, der an das Gerät übergeben wird und das Gerät für die Registrierung autorisiert. Dies ist ein schreibgeschütztes Feld, das vom Server generiert wird.

duration

string (Duration format)

Die Gültigkeitsdauer des Registrierungstokens (zwischen 1 Minute und Durations.MAX_VALUE) beträgt etwa 10.000 Jahre. Wenn keine Angabe erfolgt, beträgt die Standarddauer 1 Stunde. Wenn die angeforderte Dauer dazu führt, dass die resultierende expirationTimestamp den Wert Timestamps.MAX_VALUE überschreitet, wird expirationTimestamp zu Timestamps.MAX_VALUE erzwungen.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, die auf „s“ endet. Beispiel: "3.5s".

expirationTimestamp

string (Timestamp format)

Die Ablaufzeit des Tokens. Dies ist ein schreibgeschütztes Feld, das vom Server generiert wird.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

policyName

string

Der Name der Richtlinie, die anfänglich auf das registrierte Gerät angewendet wurde, im Format enterprises/{enterpriseId}/policies/{policyId}. Wenn keine Angabe erfolgt, wird die policyName für den Nutzer des Geräts angewendet. Wenn userName ebenfalls nicht angegeben ist, wird standardmäßig enterprises/{enterpriseId}/policies/default angewendet. Wenn Sie dieses Feld aktualisieren, können Sie nur den policyId angeben, solange policyId keine Schrägstriche enthält. Der Rest des Richtliniennamens wird abgeleitet.

additionalData

string

Optionale, mit dem Registrierungstoken verknüpfte Daten Das kann z. B. die ID einer Organisationseinheit enthalten, der das Gerät nach der Registrierung zugewiesen wird. Nach der Registrierung eines Geräts mit dem Token werden diese Daten im Feld enrollmentTokenData der Ressource Device angezeigt. Die Daten dürfen maximal 1.024 Zeichen lang sein. Andernfalls schlägt die Erstellungsanfrage fehl.

qrCode

string

Ein JSON-String, dessen UTF-8-Darstellung verwendet werden kann, um einen QR-Code für die Registrierung eines Geräts mit diesem Registrierungstoken zu generieren. Damit ein Gerät über NFC registriert werden kann, muss der NFC-Eintrag eine serielle java.util.Properties-Darstellung der Attribute im JSON-Format enthalten.

oneTimeOnly

boolean

Gibt an, ob das Registrierungstoken nur einmal verwendet werden kann. Wenn das Flag auf „true“ gesetzt ist, kann es nur von einem Gerät für die Registrierung verwendet werden.

user
(deprecated)

object (User)

Dieses Feld ist veraltet und der Wert wird ignoriert.

allowPersonalUsage

enum (AllowPersonalUsage)

Legt fest, ob ein Gerät, das mit diesem Registrierungstoken bereitgestellt wird, privat genutzt werden darf.

Für unternehmenseigene Geräte:

  • Wenn Sie die private Nutzung aktivieren, kann der Nutzer ein Arbeitsprofil auf dem Gerät einrichten.
  • Wenn Sie die private Nutzung deaktivieren möchten, muss der Nutzer das Gerät als vollständig verwaltetes Gerät bereitstellen.

Für private Geräte:

  • Wenn Sie die private Nutzung aktivieren, kann der Nutzer ein Arbeitsprofil auf dem Gerät einrichten.
  • Wenn Sie die private Nutzung deaktivieren, kann das Gerät nicht bereitgestellt werden. Die private Nutzung kann auf einem privaten Gerät nicht deaktiviert werden.

Methoden

create

Erstellt ein Registrierungstoken für ein bestimmtes Unternehmen.

delete

Löscht ein Registrierungstoken.

get

Ruft ein aktives, nicht abgelaufenes Registrierungstoken ab.

list

Listet aktive, nicht abgelaufene Registrierungstokens für ein bestimmtes Unternehmen auf.