REST Resource: enterprises.enrollmentTokens

Zasób: EnrollmentToken

Token rejestracji.

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

string

Nazwa tokena rejestracji, która jest generowana przez serwer podczas tworzenia i ma postać enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}.

value

string

Wartość tokena, która jest przekazywana do urządzenia i umożliwia jego zarejestrowanie. To pole jest przeznaczone tylko do odczytu wygenerowane przez serwer.

duration

string (Duration format)

Okres ważności tokena rejestracji (od 1 minuty do Durations.MAX_VALUE) i wynosi około 10 000 lat. Jeśli nie podasz żadnej wartości, domyślny czas trwania to 1 godzina. Pamiętaj, że jeśli żądany czas trwania powoduje, że wynikowy expirationTimestamp przekracza Timestamps.MAX_VALUE, to expirationTimestamp jest przekształcany na Timestamps.MAX_VALUE.

Czas trwania w sekundach z maksymalnie 9 cyframi po przecinku, kończącym się cyframi „s”. Przykład: "3.5s".

expirationTimestamp

string (Timestamp format)

Data ważności tokena. To pole jest przeznaczone tylko do odczytu wygenerowane przez serwer.

Sygnatura czasowa w formacie „Zulu” RFC3339 UTC z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

policyName

string

Nazwa zasady zastosowanej początkowo do zarejestrowanego urządzenia w formacie enterprises/{enterpriseId}/policies/{policyId}. Jeśli nie określisz żadnej wartości, zostanie zastosowana policyName dla użytkownika urządzenia. Jeśli nie określono także userName, domyślnie stosowana jest zasada enterprises/{enterpriseId}/policies/default. Aktualizując to pole, możesz określić tylko policyId, o ile pole policyId nie zawiera ukośników. Pozostała część nazwy zasady zostanie określona.

additionalData

string

Opcjonalne dane powiązane z tokenem rejestracji. Może to być na przykład identyfikator jednostki organizacyjnej, do której urządzenie jest przypisane po zarejestrowaniu. Gdy urządzenie zostanie zarejestrowane przy użyciu tokena, te dane będą widoczne w polu enrollmentTokenData zasobu Device. Dane mogą mieć maksymalnie 1024 znaki. W przeciwnym razie żądanie utworzenia zakończy się niepowodzeniem.

qrCode

string

Ciąg znaków JSON, którego reprezentacja UTF-8 może zostać użyta do wygenerowania kodu QR służącego do zarejestrowania urządzenia za pomocą tego tokena rejestracji. Aby zarejestrować urządzenie za pomocą NFC, rekord NFC musi zawierać zserializowaną reprezentację właściwości java.util.Properties w formacie JSON.

oneTimeOnly

boolean

Określa, czy token rejestracji jest przeznaczony tylko do jednorazowego użytku. Jeśli flaga ma wartość Prawda, tylko jedno urządzenie może jej użyć do rejestracji.

user
(deprecated)

object (User)

To pole zostało wycofane, a wartość jest ignorowana.

allowPersonalUsage

enum (AllowPersonalUsage)

Określa, czy użycie osobiste jest dozwolone na urządzeniu obsługującym ten token rejestracji.

W przypadku urządzeń należących do firmy:

  • Włączenie opcji użytku osobistego pozwala użytkownikowi skonfigurować profil służbowy na urządzeniu.
  • Wyłączenie użycia osobistego wymaga, aby użytkownik obsługiwał urządzenie jako w pełni zarządzane.

W przypadku urządzeń należących do firmy:

  • Włączenie opcji użytku osobistego pozwala użytkownikowi skonfigurować profil służbowy na urządzeniu.
  • Wyłączenie funkcji użytku osobistego uniemożliwi obsługę administracyjną urządzenia. Nie można wyłączyć korzystania z urządzenia osobistego na urządzeniu należącym do Ciebie.

Metody

create

Tworzy token rejestracji dla danej firmy.

delete

Usuwa token rejestracji.

get

Pobiera aktywny, niewygasły token rejestracji.

list

Wyświetla listę aktywnych tokenów rejestracji w danej firmie.