- HTTP-запрос
- Параметры пути
- Текст запроса
- Тело ответа
- Области авторизации
- Команда
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- AddEsimParams
- ActivationState
- RemoveEsimParams
- RequestDeviceInfoParams
- Информация об устройстве
- WipeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Статус
- StopLostModeStatus
- Статус
- EsimCommandStatus
- Статус
- InternalErrorDetails
- OperationCodeDetail
- ErrorCodeDetail
- EsimInfo
- RequestDeviceInfoStatus
- Статус
- EidInfo
- Ид
- Попробуйте!
Выдаёт команду устройству. Возвращаемый ресурс Operation
содержит Command
в поле metadata
. Используйте метод get_operation , чтобы получить статус команды.
HTTP-запрос
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
URL использует синтаксис перекодировки gRPC .
Параметры пути
Параметры | |
---|---|
name | Имя устройства в формате |
Текст запроса
Тело запроса содержит экземпляр Command
.
Тело ответа
В случае успеха тело ответа содержит экземпляр Operation
.
Области авторизации
Требуется следующая область OAuth:
-
https://www.googleapis.com/auth/androidmanagement
Для получения более подробной информации см.OAuth 2.0 Overview .
Команда
Команда.
JSON-представление |
---|
{ "type": enum ( |
Поля | |
---|---|
type | Тип команды. |
createTime | Временная метка создания команды. Временная метка автоматически генерируется сервером. Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: |
duration | Время действия команды. Если устройство не выполнит команду в течение этого времени, команда будет аннулирована. Время действия по умолчанию, если не указано иное, составляет десять минут. Максимального значения нет. Длительность в секундах, содержащая до девяти знаков после запятой, заканчивается на « |
userName | Имя ресурса пользователя, владеющего устройством, в формате |
errorCode | Если команда не выполнена, код ошибки, объясняющий сбой. Этот код не устанавливается, если команда отменена вызывающим кодом. Для анализа ошибок команды предпочтительнее использовать поля в следующем порядке (наиболее предпочтительные поля указаны первыми): 1. Поля, специфичные для команды, такие как |
newPassword | Для команд типа |
resetPasswordFlags[] | Для команд типа |
Если это установлено, то поля | |
clearAppsDataParams | Параметры команды |
startLostModeParams | Параметры команды |
stopLostModeParams | Параметры команды |
addEsimParams | Необязательные параметры для команды |
removeEsimParams | Необязательные параметры для команды |
requestDeviceInfoParams | Необязательные параметры команды |
wipeParams | Необязательные параметры для команды |
Поле объединения status . Статус, специфичный для команды. Обратите внимание, что некоторые команды не используют его, в частности, , , и . В будущем эти команды также могут его использовать. status может быть только одним из следующих: | |
clearAppsDataStatus | Только вывод. Статус команды |
startLostModeStatus | Только вывод. Состояние команды |
stopLostModeStatus | Только вывод. Статус команды |
esimStatus | Только вывод. Состояние команды |
requestDeviceInfoStatus | Только вывод. Статус команды |
CommandType
Типы команд.
Перечисления | |
---|---|
COMMAND_TYPE_UNSPECIFIED | Это значение недопустимо. |
LOCK | Заблокируйте устройство, как будто истекло время ожидания блокировки экрана. |
RESET_PASSWORD | Сброс пароля пользователя. |
REBOOT | Перезагрузите устройство. Поддерживается только на полностью управляемых устройствах под управлением Android 7.0 (уровень API 24) или выше. |
RELINQUISH_OWNERSHIP | Удаляет рабочий профиль и все политики с корпоративного устройства Android 8.0+, предоставляя устройство для личного использования. Приложения и данные, связанные с личным профилем (профилями), сохраняются. Устройство будет удалено с сервера после подтверждения команды. |
CLEAR_APP_DATA | Очищает данные указанных приложений. Поддерживается на Android 9 и более поздних версиях. Обратите внимание, что приложение может хранить данные вне своих данных, например, во внешнем хранилище или в пользовательском словаре. См. также . |
START_LOST_MODE | Переводит устройство в режим пропажи. Поддерживается только на полностью управляемых устройствах или устройствах организации с управляемым профилем. См. также . |
STOP_LOST_MODE | Выводит устройство из режима пропажи. Поддерживается только на полностью управляемых устройствах или устройствах организации с управляемым профилем. См. также . |
ADD_ESIM | Добавляет профиль eSIM на устройство. Поддерживается на Android 15 и более поздних версиях. См. также . Чтобы удалить профиль eSIM, используйте команду . Чтобы определить, что происходит с профилем eSIM при очистке устройства, установите в политике. Примечание: для подготовки нескольких карт eSIM на одном устройстве рекомендуется установить задержку в несколько минут между последовательными выполнениями команды. |
REMOVE_ESIM | Удаляет профиль eSIM с устройства. Поддерживается на Android 15 и выше. См. также . |
REQUEST_DEVICE_INFO | Запросить информацию, связанную с устройством. |
WIPE | Очищает устройство, восстанавливая заводские настройки для корпоративного устройства или удаляя рабочий профиль для личного устройства с рабочим профилем. Очистка происходит только после того, как устройство подтвердит команду. Команду можно отменить до этого. |
CommandErrorCode
Код ошибки команды. Это поле доступно только для чтения и заполняется сервером.
Перечисления | |
---|---|
COMMAND_ERROR_CODE_UNSPECIFIED | Ошибки не было. |
UNKNOWN | Произошла неизвестная ошибка. |
API_LEVEL | Уровень API устройства не поддерживает эту команду. |
MANAGEMENT_MODE | Режим управления (владелец профиля, владелец устройства и т. д.) не поддерживает команду. |
INVALID_VALUE | Команда имеет недопустимое значение параметра. |
UNSUPPORTED | Устройство не поддерживает эту команду. Обновление Android Device Policy до последней версии может решить проблему. |
ResetPasswordFlag
Флаги, которые можно использовать для типа команды RESET_PASSWORD
.
Перечисления | |
---|---|
RESET_PASSWORD_FLAG_UNSPECIFIED | Это значение игнорируется. |
REQUIRE_ENTRY | Не разрешайте другим администраторам менять пароль, пока пользователь его не введет. |
DO_NOT_ASK_CREDENTIALS_ON_BOOT | Не запрашивайте учетные данные пользователя при загрузке устройства. |
LOCK_NOW | Заблокируйте устройство после сброса пароля. |
ClearAppsDataParams
Параметры, связанные с командой
для очистки данных указанных приложений с устройства. CLEAR_APP_DATA
JSON-представление |
---|
{ "packageNames": [ string ] } |
Поля | |
---|---|
packageNames[] | Имена пакетов приложений, данные которых будут очищены при выполнении команды. |
StartLostModeParams
Параметры, связанные с командой
для перевода устройства в режим пропажи. Для перевода устройства в режим пропажи необходимо указать хотя бы один из параметров, не включая название организации. START_LOST_MODE
JSON-представление |
---|
{ "lostMessage": { object ( |
Поля | |
---|---|
lostMessage | Сообщение, отображаемое пользователю, когда устройство находится в режиме утери. |
lostPhoneNumber | Номер телефона, на который будет совершен вызов при нажатии кнопки вызова владельца устройства, находящегося в режиме утери. |
lostEmailAddress | Адрес электронной почты, отображаемый пользователю, когда устройство находится в режиме утери. |
lostStreetAddress | Адрес, отображаемый пользователю, когда устройство находится в режиме утери. |
lostOrganization | Название организации, отображаемое пользователю, когда устройство находится в режиме утери. |
StopLostModeParams
Этот тип не имеет полей.
Параметры, связанные с командой
для вывода устройства из режима потери. STOP_LOST_MODE
AddEsimParams
Параметры, связанные с командой
для добавления профиля eSIM на устройство. ADD_ESIM
JSON-представление |
---|
{
"activationCode": string,
"activationState": enum ( |
Поля | |
---|---|
activationCode | Обязательно. Код активации профиля eSIM. |
activationState | Обязательно. Состояние активации профиля eSIM после его загрузки. |
ActivationState
Состояние активации профиля eSIM после его загрузки.
Перечисления | |
---|---|
ACTIVATION_STATE_UNSPECIFIED | Состояние активации eSIM не указано. По умолчанию профиль eSIM находится в состоянии на личных устройствах и на корпоративных устройствах. |
ACTIVATED | eSIM активируется автоматически после загрузки. Если вы установите этот режим активации для личных устройств, команда будет отклонена. |
NOT_ACTIVATED | Профиль eSIM загружается, но не активируется. В этом случае пользователю потребуется вручную активировать eSIM на устройстве. |
RemoveEsimParams
Параметры, связанные с командой
для удаления профиля eSIM с устройства. REMOVE_ESIM
JSON-представление |
---|
{ "iccId": string } |
Поля | |
---|---|
iccId | Обязательно. Идентификатор ICC профиля eSIM, который необходимо удалить. |
RequestDeviceInfoParams
Параметры, связанные с командой
для получения информации об устройстве. REQUEST_DEVICE_INFO
JSON-представление |
---|
{
"deviceInfo": enum ( |
Поля | |
---|---|
deviceInfo | Обязательно. Тип запрашиваемой информации об устройстве. |
Информация об устройстве
Тип запрашиваемой информации об устройстве.
Перечисления | |
---|---|
DEVICE_INFO_UNSPECIFIED | Это значение недопустимо. |
EID | Запросите идентификатор eSIM. Пользователю будет предложено подтвердить раскрытие информации, прежде чем будет выдан результат. Если пользователь не подтвердит раскрытие, будет возвращено . Эта функция поддерживается только для личных устройств с рабочими профилями и Android версии 13 и выше. |
WipeParams
Параметры, связанные с командой
для очистки устройства. WIPE
JSON-представление |
---|
{ "wipeDataFlags": [ enum ( |
Поля | |
---|---|
wipeDataFlags[] | Необязательно. Флаги для определения данных, подлежащих удалению. |
wipeReason | Необязательно. Короткое сообщение, отображаемое пользователю перед очисткой рабочего профиля на личных устройствах. Это не влияет на устройства, принадлежащие компании. Максимальная длина сообщения — 200 символов. |
ClearAppsDataStatus
Состояние команды
для очистки данных указанных приложений с устройства. CLEAR_APP_DATA
JSON-представление |
---|
{
"results": {
string: {
object ( |
Поля | |
---|---|
results | Результаты для каждого приложения, сопоставление имен пакетов с соответствующим результатом очистки. Объект, содержащий список пар |
PerAppResult
Результат попытки очистить данные одного приложения.
JSON-представление |
---|
{
"clearingResult": enum ( |
Поля | |
---|---|
clearingResult | Результат попытки очистить данные одного приложения. |
ClearingResult
Результат попытки очистить данные одного приложения.
Перечисления | |
---|---|
CLEARING_RESULT_UNSPECIFIED | Результат не определен. |
SUCCESS | Данные этого приложения были успешно удалены. |
APP_NOT_FOUND | Данные этого приложения не удалось удалить, так как приложение не найдено. |
APP_PROTECTED | Данные этого приложения не могут быть удалены, поскольку оно защищено. Например, это может относиться к приложениям, критически важным для работы устройства, таким как Google Play Маркет. |
API_LEVEL | Не удалось очистить данные этого приложения, поскольку уровень API устройства не поддерживает эту команду. |
StartLostModeStatus
Состояние команды
для перевода устройства в режим потери. START_LOST_MODE
JSON-представление |
---|
{
"status": enum ( |
Поля | |
---|---|
status | Статус. См. |
Статус
Статус. См.
. StartLostModeStatus
Перечисления | |
---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCESS | Устройство было переведено в режим пропажи. |
RESET_PASSWORD_RECENTLY | Устройство не удалось перевести в режим пропажи, поскольку администратор недавно сбросил пароль устройства. |
USER_EXIT_LOST_MODE_RECENTLY | Устройство не удалось перевести в режим пропажи, поскольку пользователь недавно вышел из режима пропажи. |
ALREADY_IN_LOST_MODE | Устройство уже находится в режиме утери. |
StopLostModeStatus
Состояние команды
для вывода устройства из режима потери. STOP_LOST_MODE
JSON-представление |
---|
{
"status": enum ( |
Поля | |
---|---|
status | Статус. См. |
Статус
Статус. См.
. StopLostModeStatus
Перечисления | |
---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCESS | Устройство выведено из режима пропажи. |
NOT_IN_LOST_MODE | Устройство не находится в режиме пропажи. |
EsimCommandStatus
Сведения о состоянии и ошибках (если есть) команды
или ADD_ESIM
. REMOVE_ESIM
JSON-представление |
---|
{ "status": enum ( |
Поля | |
---|---|
status | Только вывод. Состояние команды |
esimInfo | Только вывод. Информация о добавлении или удалении eSIM. Заполняется только при |
Поле объединения status_details . Подробная информация о статусе команды или . status_details может быть только одним из следующих: | |
internalErrorDetails | Только вывод. Подробности ошибки, если |
Статус
Статус команды
или ADD_ESIM
. REMOVE_ESIM
Перечисления | |
---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCESS | Операция eSIM на устройстве была успешно выполнена. |
IN_PROGRESS | Операция eSIM находится в процессе выполнения. |
PENDING_USER_ACTION | Для продолжения работы eSIM пользователю необходимо выполнить действие. |
ERROR_SETUP_IN_PROGRESS | Операция eSIM не может быть выполнена во время настройки. |
ERROR_USER_DENIED | Пользователь отклонил операцию eSIM. |
INTERNAL_ERROR | Произошла ошибка при попытке добавить или удалить eSIM на устройстве, см. . |
ERROR_ICC_ID_NOT_FOUND | При выполнении команды удаляемой eSIM-карты не найден на устройстве. Это может означать, что eSIM не принадлежит предприятию или eSIM, соответствующая , отсутствует на устройстве. |
ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT | Команда не удалось выполнить при попытке добавить новую eSIM с активацией , поскольку несколько слотов eSIM на устройстве содержат активные профили eSIM, а свободного слота eSIM нет. Чтобы решить эту проблему, можно добавить новую eSIM с активацией для последующей ручной активации, или пользователю необходимо сначала деактивировать существующую активную eSIM для продолжения операции. |
InternalErrorDetails
Сведения о внутренней ошибке, если таковые имеются для команды
или ADD_ESIM
. REMOVE_ESIM
JSON-представление |
---|
{ "operationCode": string, "errorCode": string, "operationCodeDetail": enum ( |
Поля | |
---|---|
operationCode | Только вывод. Целочисленное представление кода операции, как указано здесь . Подробнее см. |
errorCode | Только вывод. Целочисленное представление кода ошибки, как указано здесь . См. также |
operationCodeDetail | Только вывод. Код операции, соответствующий параметру |
errorCodeDetail | Только вывод. Код ошибки, соответствующий |
OperationCodeDetail
Деталь кода операции, соответствующая
. operationCode
Перечисления | |
---|---|
OPERATION_CODE_DETAIL_UNSPECIFIED | Код операции не указан. Код не распознаётся API управления Android. См. также . |
OPERATION_SYSTEM | Подробности смотрите в EuiccManager.OPERATION_SYSTEM . |
OPERATION_SIM_SLOT | Подробности смотрите в EuiccManager.OPERATION_SIM_SLOT . |
OPERATION_EUICC_CARD | Подробности см. в EuiccManager.OPERATION_EUICC_CARD . |
OPERATION_SMDX | Подробности смотрите в EuiccManager.OPERATION_SMDX . |
OPERATION_SWITCH | Подробности смотрите в EuiccManager.OPERATION_SWITCH . |
OPERATION_DOWNLOAD | Подробности смотрите в EuiccManager.OPERATION_DOWNLOAD . |
OPERATION_METADATA | Подробности смотрите в EuiccManager.OPERATION_METADATA . |
OPERATION_EUICC_GSMA | Подробности см. в EuiccManager.OPERATION_EUICC_GSMA . |
OPERATION_APDU | Подробности смотрите в EuiccManager.OPERATION_APDU . |
OPERATION_SMDX_SUBJECT_REASON_CODE | Подробнее см. EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE . Обратите внимание, что в данном случае — это младшие 3 байта EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE , определяющие код субъекта и код причины, как указано здесь . Старший байт целого числа обнуляется. Например, код субъекта 8.11.1 и код причины 5.1 представлены в как 0000 0000 1000 1011 0001 0000 0101 0001 в двоичном формате, что соответствует 9113681 в десятичном формате. |
OPERATION_HTTP | Подробности смотрите в EuiccManager.OPERATION_HTTP . |
ErrorCodeDetail
Подробный код ошибки, соответствующий
. errorCode
Перечисления | |
---|---|
ERROR_CODE_DETAIL_UNSPECIFIED | Код ошибки не указан. Этот не распознаётся API управления Android. См. также
|
ERROR_TIME_OUT | Подробности смотрите в EuiccManager.ERROR_TIME_OUT . |
ERROR_EUICC_MISSING | Подробности см. в EuiccManager.ERROR_EUICC_MISSING . |
ERROR_UNSUPPORTED_VERSION | Подробности см. в EuiccManager.ERROR_UNSUPPORTED_VERSION . |
ERROR_ADDRESS_MISSING | Подробности см. в EuiccManager.ERROR_ADDRESS_MISSING . |
ERROR_INVALID_CONFIRMATION_CODE | Подробности см. в EuiccManager.ERROR_INVALID_CONFIRMATION_CODE . |
ERROR_CERTIFICATE_ERROR | Подробности смотрите в EuiccManager.ERROR_CERTIFICATE_ERROR . |
ERROR_NO_PROFILES_AVAILABLE | Подробности см. в EuiccManager.ERROR_NO_PROFILES_AVAILABLE . |
ERROR_CONNECTION_ERROR | Подробности см. в EuiccManager.ERROR_CONNECTION_ERROR . |
ERROR_INVALID_RESPONSE | Подробности см. в EuiccManager.ERROR_INVALID_RESPONSE . |
ERROR_CARRIER_LOCKED | Подробности см. в EuiccManager.ERROR_CARRIER_LOCKED . |
ERROR_DISALLOWED_BY_PPR | Подробности см. в EuiccManager.ERROR_DISALLOWED_BY_PPR . |
ERROR_INVALID_ACTIVATION_CODE | Подробности см. в EuiccManager.ERROR_INVALID_ACTIVATION_CODE . |
ERROR_INCOMPATIBLE_CARRIER | Подробности см. в EuiccManager.ERROR_INCOMPATIBLE_CARRIER . |
ERROR_OPERATION_BUSY | Подробности см. в EuiccManager.ERROR_OPERATION_BUSY . |
ERROR_INSTALL_PROFILE | Подробности смотрите в EuiccManager.ERROR_INSTALL_PROFILE . |
ERROR_EUICC_INSUFFICIENT_MEMORY | Подробности см. в EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY . |
ERROR_INVALID_PORT | Подробности см. в EuiccManager.ERROR_INVALID_PORT . |
ERROR_SIM_MISSING | Подробности смотрите в EuiccManager.ERROR_SIM_MISSING . |
EsimInfo
Подробная информация о добавленной или удаленной eSIM.
JSON-представление |
---|
{ "iccId": string } |
Поля | |
---|---|
iccId | Только вывод. ICC-идентификатор eSIM. |
RequestDeviceInfoStatus
Статус команды
. REQUEST_DEVICE_INFO
JSON-представление |
---|
{ "status": enum ( |
Поля | |
---|---|
status | Только вывод. Статус команды |
Поле объединения device_info . Подробная информация об устройстве, запрошенная администратором. Заполняется только при . device_info может быть только одним из следующих: | |
eidInfo | Информация, связанная с EID устройства. |
Статус
Статус команды
. REQUEST_DEVICE_INFO
Перечисления | |
---|---|
STATUS_UNSPECIFIED | Не указано. Это значение не используется. |
SUCCEEDED | Информация об устройстве успешно доставлена. |
PENDING_USER_ACTION | Пользователь не выполнил действия, необходимые для обмена информацией об устройстве. |
USER_DECLINED | Пользователь отказался предоставить информацию об устройстве. |
UNSUPPORTED | Запрошенная информация об устройстве не поддерживается на этом устройстве, например, eSIM не поддерживается на устройстве. |
EidInfo
Информация, связанная с EID устройства.
JSON-представление |
---|
{
"eids": [
{
object ( |
Поля | |
---|---|
eids[] | Только вывод. Информация EID для каждого чипа eUICC. |
Ид
Информация EID для каждого чипа eUICC.
JSON-представление |
---|
{ "eid": string } |
Поля | |
---|---|
eid | Только выход. EID |