- HTTP-запрос
- Параметры пути
- Текст запроса
- Тело ответа
- Области действия авторизации
- Команда
- ТипКоманды
- CommandErrorCode
- СбросПароляФлаг
- Clearappsdataparams
- StartLostModeParams
- StopLostModeParams
- ДобавитьEsimParams
- СостояниеАктивации
- УдалитьEsimParams
- ЗапроситьПараметрыИнформацииУстройства
- Информация об устройстве
- WipeParams
- ОчиститьПриложенияДанныеСтатус
- PerAppResult
- ОчисткаРезультат
- StartLostModeStatus
- Статус
- StopLostModeStatus
- Статус
- EsimCommandStatus
- Статус
- ВнутренняяОшибкаПодробности
- OperationCodeDetail
- КодОшибкиПодробнее
- EsimInfo
- ЗапроситьИнформациюОстатусеУстройства
- Статус
- EidInfo
- Ид
- Попробуйте!
Выдает команду устройству. Возвращенный ресурс Operation
содержит Command
в поле metadata
. Используйте метод get operation для получения статуса команды.
HTTP-запрос
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
URL-адрес использует синтаксис gRPC Transcoding .
Параметры пути
Параметры | |
---|---|
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 | Только вывод. Статус команды |
ТипКоманды
Типы команд.
Перечисления | |
---|---|
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 до последней версии может решить проблему. |
СбросПароляФлаг
Флаги, которые можно использовать для типа команды RESET_PASSWORD
.
Перечисления | |
---|---|
RESET_PASSWORD_FLAG_UNSPECIFIED | Это значение игнорируется. |
REQUIRE_ENTRY | Не позволяйте другим администраторам снова менять пароль, пока пользователь его не введет. |
DO_NOT_ASK_CREDENTIALS_ON_BOOT | Не запрашивайте учетные данные пользователя при загрузке устройства. |
LOCK_NOW | Блокируйте устройство после сброса пароля. |
ОчиститьПриложенияДанныеПараметры
Параметры, связанные с командой
для очистки данных указанных приложений с устройства. CLEAR_APP_DATA
JSON-представление |
---|
{ "packageNames": [ string ] } |
Поля | |
---|---|
packageNames[] | Имена пакетов приложений, данные которых будут очищены при выполнении команды. |
StartLostModeParams
Параметры, связанные с командой
для перевода устройства в режим утери. Для перевода устройства в режим утери необходимо указать хотя бы один из параметров, не включая название организации. START_LOST_MODE
JSON-представление |
---|
{ "lostMessage": { object ( |
Поля | |
---|---|
lostMessage | Сообщение, отображаемое пользователю, когда устройство находится в режиме утери. |
lostPhoneNumber | Номер телефона, на который будет совершен вызов, если устройство находится в режиме утери и нажата кнопка вызова владельца. |
lostEmailAddress | Адрес электронной почты, отображаемый пользователю, когда устройство находится в режиме пропажи. |
lostStreetAddress | Почтовый адрес, отображаемый пользователю, когда устройство находится в режиме утери. |
lostOrganization | Название организации, отображаемое пользователю, когда устройство находится в режиме утери. |
StopLostModeParams
Этот тип не имеет полей.
Параметры, связанные с командой
для вывода устройства из режима потери. STOP_LOST_MODE
ДобавитьEsimParams
Параметры, связанные с командой
для добавления профиля eSIM на устройство. ADD_ESIM
JSON-представление |
---|
{
"activationCode": string,
"activationState": enum ( |
Поля | |
---|---|
activationCode | Обязательно. Код активации для профиля eSIM. |
activationState | Обязательно. Состояние активации профиля eSIM после его загрузки. |
СостояниеАктивации
Состояние активации профиля eSIM после его загрузки.
Перечисления | |
---|---|
ACTIVATION_STATE_UNSPECIFIED | Состояние активации eSIM не указано. По умолчанию профиль eSIM на личных устройствах и на корпоративных устройствах. |
ACTIVATED | eSIM автоматически активируется после загрузки. Установка этого состояния активации для личных устройств приведет к отклонению команды. |
NOT_ACTIVATED | Профиль eSIM загружен, но не активирован. В этом случае пользователю необходимо будет вручную активировать eSIM на устройстве. |
УдалитьEsimParams
Параметры, связанные с командой
, для удаления профиля ESIM с устройства. REMOVE_ESIM
JSON-представление |
---|
{ "iccId": string } |
Поля | |
---|---|
iccId | Обязательно. ICC-идентификатор профиля eSIM, который необходимо удалить. |
ЗапроситьПараметрыИнформацииУстройства
Параметры, связанные с командой
, для получения информации об устройстве. REQUEST_DEVICE_INFO
JSON-представление |
---|
{
"deviceInfo": enum ( |
Поля | |
---|---|
deviceInfo | Обязательно. Тип запрашиваемой информации об устройстве. |
Информация об устройстве
Тип запрашиваемой информации об устройстве.
Перечисления | |
---|---|
DEVICE_INFO_UNSPECIFIED | Это значение недопустимо. |
EID | Запросить идентификатор для eSIM. Пользователю будет предложено одобрить раскрытие информации, прежде чем результат может быть возвращен. Если пользователь не одобрит раскрытие, будет возвращен . Это поддерживается только для личных устройств с рабочими профилями и Android версии 13 и выше. |
WipeParams
Параметры, связанные с командой
для очистки устройства. WIPE
JSON-представление |
---|
{ "wipeDataFlags": [ enum ( |
Поля | |
---|---|
wipeDataFlags[] | Необязательно. Флаги для определения того, какие данные следует стереть. |
wipeReason | Необязательно. Короткое сообщение, отображаемое пользователю перед очисткой рабочего профиля на личных устройствах. Это не влияет на устройства, принадлежащие компании. Максимальная длина сообщения — 200 символов. |
ОчиститьПриложенияДанныеСтатус
Состояние команды
для очистки данных указанных приложений с устройства. CLEAR_APP_DATA
JSON-представление |
---|
{
"results": {
string: {
object ( |
Поля | |
---|---|
results | Результаты для каждого приложения, сопоставление имен пакетов с соответствующим результатом очистки. Объект, содержащий список пар |
PerAppResult
Результат попытки очистить данные одного приложения.
JSON-представление |
---|
{
"clearingResult": enum ( |
Поля | |
---|---|
clearingResult | Результат попытки очистить данные одного приложения. |
ОчисткаРезультат
Результат попытки очистить данные одного приложения.
Перечисления | |
---|---|
CLEARING_RESULT_UNSPECIFIED | Результат не указан. |
SUCCESS | Данные этого приложения были успешно очищены. |
APP_NOT_FOUND | Данные этого приложения не могут быть очищены, поскольку приложение не найдено. |
APP_PROTECTED | Данные этого приложения не могут быть очищены, поскольку приложение защищено. Например, это может относиться к приложениям, критически важным для функционирования устройства, таким как Google Play Store. |
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, чтобы операция продолжилась. |
ВнутренняяОшибкаПодробности
Сведения о внутренней ошибке, если таковые имеются для команды
или 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 . |
КодОшибкиПодробнее
Подробный код ошибки, соответствующий
. 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. |
ЗапроситьИнформациюОстатусеУстройства
Статус команды
. 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 |