REST Resource: enterprises.enrollmentTokens

Ресурс: EnrollmentToken

Регистрационный токен.

JSON-представление 
{
  "name": string,
  "value": string,
  "duration": string,
  "expirationTimestamp": string,
  "policyName": string,
  "additionalData": string,
  "qrCode": string,
  "oneTimeOnly": boolean,
  "user": {
    object (User)
  },
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "googleAuthenticationOptions": {
    object (GoogleAuthenticationOptions)
  }
}
Поля
name

string

Имя токена регистрации, генерируемое сервером при создании, имеет вид enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId} .

value

string

Значение токена, передаваемое устройству и разрешающее ему зарегистрироваться. Это поле, доступное только для чтения, генерируется сервером.

duration

string ( Duration format)

Продолжительность действия регистрационного токена варьируется от 1 минуты до Durations.MAX_VALUE , что составляет приблизительно 10 000 лет. Если не указано иное, по умолчанию используется 1 час. Обратите внимание, что если запрошенная продолжительность приводит к превышению значения expirationTimestamp значения Timestamps.MAX_VALUE , то expirationTimestamp будет преобразовано в Timestamps.MAX_VALUE .

Длительность в секундах, содержащая до девяти знаков после запятой, заканчивающаяся на « s ». Пример: "3.5s" .

expirationTimestamp

string ( Timestamp format)

Время истечения срока действия токена. Это поле, доступное только для чтения, генерируется сервером.

Используется RFC 3339, согласно которому генерируемый вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

policyName

string

Название политики, первоначально применяемой к зарегистрированному устройству, имеет вид enterprises/{enterpriseId}/policies/{policyId} . Если не указано, применяется policyName для пользователя устройства. Если userName также не указано, по умолчанию применяется enterprises/{enterpriseId}/policies/default . При обновлении этого поля можно указать только policyId , если policyId не содержит косых черт. Остальная часть названия политики будет определена автоматически.

additionalData

string

Необязательные, произвольные данные, связанные с токеном регистрации. Они могут содержать, например, идентификатор организационного подразделения, к которому устройство будет привязано после регистрации. После регистрации устройства с использованием токена эти данные будут отображаться в поле enrollmentTokenData ресурса Device . Длина данных не должна превышать 1024 символа; в противном случае запрос на создание завершится неудачей.

qrCode

string

Строка JSON, представление которой в кодировке UTF-8 может быть использовано для генерации QR-кода для регистрации устройства с помощью этого токена регистрации. Для регистрации устройства с использованием NFC запись NFC должна содержать сериализованное представление свойств из JSON в формате java.util.Properties .

oneTimeOnly

boolean

Указывает, предназначен ли регистрационный токен для одноразового использования. Если этот параметр установлен в значение true, то для регистрации может использоваться только одно устройство.

user
(deprecated)

object ( User )

Это поле устарело, и его значение игнорируется.

allowPersonalUsage

enum ( AllowPersonalUsage )

Определяет, разрешено ли личное использование на устройстве, которому присвоен этот регистрационный токен.

Для устройств, принадлежащих компании:

  • Включение персонального использования позволяет пользователю настроить рабочий профиль на устройстве.
  • Для отключения персонального использования пользователю необходимо настроить устройство как полностью управляемое.

Для личных устройств:

  • Включение персонального использования позволяет пользователю настроить рабочий профиль на устройстве.
  • Отключение персонального использования не позволит устройству выполнить инициализацию. Отключение персонального использования на личном устройстве невозможно.
googleAuthenticationOptions

object ( GoogleAuthenticationOptions )

Необязательно. Параметры, связанные с аутентификацией Google во время регистрации.

GoogleAuthenticationOptions

Варианты аутентификации Google во время регистрации.

При запуске регистрации с помощью SigninDetail эти параметры применяются после того, как пользователь завершит вход через сторонний сервис и будет создан EnrollmentToken. Если для этого токена параметр authenticationRequirement установлен в REQUIRED , эти параметры взаимодействуют с SigninDetail.googleAuthenticationOptions , инициировавшим процесс, следующим образом: - Если пользователь пропустил вход через Google ранее (что разрешено SigninDetail.googleAuthenticationOptions ), возникнет ошибка, и пользователю будет предложено войти снова. - Если для этого токена установлен параметр requiredAccountEmail , а пользователь ранее входил с другим адресом электронной почты, возникнет ошибка, и пользователю будет предложено войти снова с правильной учетной записью.

JSON-представление 
{
  "authenticationRequirement": enum (AuthenticationRequirement),
  "requiredAccountEmail": string
}
Поля
authenticationRequirement

enum ( AuthenticationRequirement )

Необязательный параметр. Указывает, должен ли пользователь проходить аутентификацию в Google во время регистрации. Если установлено любое значение, отличное от AUTHENTICATION_REQUIREMENT_UNSPECIFIED , параметр корпоративного уровня googleAuthenticationSettings игнорируется для устройств, зарегистрированных с использованием этого токена.

requiredAccountEmail

string

Необязательно. Указывает управляемую учетную запись Google, которую пользователь должен использовать при регистрации. Это поле можно заполнить только в том случае, если для AuthenticationRequirement установлено значение REQUIRED .

Требование аутентификации

Указывает, должен ли пользователь проходить аутентификацию в Google во время регистрации. Это переопределяет настройку корпоративного уровня googleAuthenticationSettings .

Перечисления
AUTHENTICATION_REQUIREMENT_UNSPECIFIED Параметр googleAuthenticationSettings для предприятия, к которому принадлежит этот токен регистрации, используется для определения того, нужно ли пользователю проходить аутентификацию в Google во время регистрации.
OPTIONAL Аутентификация через Google является необязательной для пользователя. Это означает, что пользователь может пропустить аутентификацию через Google во время регистрации.
REQUIRED Для продолжения работы пользователю требуется аутентификация через Google. Это означает, что для этого пользователь должен пройти аутентификацию с помощью учетной записи Google.

Методы

create

 Создает токен регистрации для заданного предприятия.

delete

 Удаляет токен регистрации.

get

 Получает активный, действующий токен регистрации.

list

 Отображает список активных и непросроченных токенов регистрации для данного предприятия.