- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- Comando
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- AddEsimParams
- ActivationState
- RemoveEsimParams
- RequestDeviceInfoParams
- DeviceInfo
- WipeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Estado
- StopLostModeStatus
- Estado
- EsimCommandStatus
- Estado
- InternalErrorDetails
- OperationCodeDetail
- ErrorCodeDetail
- EsimInfo
- RequestDeviceInfoStatus
- Estado
- EidInfo
- Eid
- Pruébalo
Emite un comando a un dispositivo. El recurso Operation
que se devuelve contiene un Command
en su campo metadata
. Usa el método get operation para obtener el estado del comando.
Solicitud HTTP
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
name |
Nombre del dispositivo con el formato |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una instancia de Command
.
Cuerpo de la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation
.
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/androidmanagement
Para obtener más información, consulta OAuth 2.0 Overview.
Comando
Un comando.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Es el tipo de comando. |
createTime |
Es la marca de tiempo en la que se creó el comando. El servidor genera automáticamente la marca de tiempo. Usa el RFC 3339, en el que el resultado generado siempre se normaliza según la zona horaria Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean "Z". Ejemplos: |
duration |
Es la duración durante la cual el comando es válido. El comando vencerá si el dispositivo no lo ejecuta durante este período. La duración predeterminada, si no se especifica, es de diez minutos. No hay una duración máxima. Una duración en segundos con hasta nueve dígitos decimales, que terminan en “ |
userName |
Es el nombre del recurso del usuario propietario del dispositivo en el formato |
errorCode |
Si el comando falló, se muestra un código de error que explica la falla. No se establece cuando el emisor cancela el comando. Para razonar sobre los errores de comandos, prefiere los campos en el siguiente orden (primero el más preferido): 1. Campos específicos del comando, como |
newPassword |
Para los comandos de tipo |
resetPasswordFlags[] |
Para los comandos de tipo |
Campo de unión Si se establece este campo, no se deben establecer los campos |
|
clearAppsDataParams |
Son los parámetros del comando |
startLostModeParams |
Son los parámetros del comando |
stopLostModeParams |
Parámetros del comando |
addEsimParams |
Opcional. Son los parámetros del comando |
removeEsimParams |
Opcional. Son los parámetros del comando |
requestDeviceInfoParams |
Opcional. Son los parámetros del comando |
wipeParams |
Opcional. Parámetros para el comando |
Campo de unión status . Es el estado específico del comando. Ten en cuenta que algunos comandos no usan esto, en particular , , y . En el futuro, es posible que estos comandos también lo usen. status puede ser solo uno de los siguientes: |
|
clearAppsDataStatus |
Solo salida. Es el estado del comando |
startLostModeStatus |
Solo salida. Es el estado del comando |
stopLostModeStatus |
Solo salida. Es el estado del comando |
esimStatus |
Solo salida. Es el estado de un comando |
requestDeviceInfoStatus |
Solo salida. Es el estado del comando |
CommandType
Tipos de comandos
Enumeraciones | |
---|---|
COMMAND_TYPE_UNSPECIFIED |
Este valor no está permitido. |
LOCK |
Bloquea el dispositivo, como si hubiera vencido el tiempo de espera de la pantalla de bloqueo. |
RESET_PASSWORD |
Restablece la contraseña del usuario. |
REBOOT |
Reinicia el dispositivo. Solo se admite en dispositivos completamente administrados que ejecutan Android 7.0 (nivel de API 24) o versiones posteriores. |
RELINQUISH_OWNERSHIP |
Quita el perfil de trabajo y todas las políticas de un dispositivo Android 8.0 o versiones posteriores propiedad de la empresa, y libera el dispositivo para uso personal. Se conservan las apps y los datos asociados con los perfiles personales. El dispositivo se borrará del servidor después de que confirme el comando. |
CLEAR_APP_DATA |
Borra los datos de la aplicación de las apps especificadas. Esta función es compatible con Android 9 y versiones posteriores. Ten en cuenta que una aplicación puede almacenar datos fuera de sus datos de aplicación, por ejemplo, en un almacenamiento externo o en un diccionario del usuario. Consulta también . |
START_LOST_MODE |
Pone el dispositivo en modo perdido. Solo se admite en dispositivos completamente administrados o dispositivos propiedad de la organización con un perfil administrado. Consulta también . |
STOP_LOST_MODE |
Quita el dispositivo del modo extraviado. Solo se admite en dispositivos completamente administrados o dispositivos propiedad de la organización con un perfil administrado. Consulta también . |
ADD_ESIM |
Agrega un perfil de eSIM al dispositivo. Esta función es compatible con Android 15 y versiones posteriores. Consulta también . Para quitar un perfil de eSIM, usa el comando . Para determinar qué sucede con el perfil de eSIM cuando se borra un dispositivo, establece en la política. Nota: Para aprovisionar varias eSIM en un solo dispositivo, se recomienda introducir una demora de unos minutos entre las ejecuciones sucesivas del comando. |
REMOVE_ESIM |
Quita un perfil de eSIM del dispositivo. Esta función es compatible con Android 15 y versiones posteriores. Consulta también . |
REQUEST_DEVICE_INFO |
Solicitar información relacionada con el dispositivo |
WIPE |
Borra el dispositivo a través de un restablecimiento de la configuración de fábrica en el caso de un dispositivo de la empresa o borrando el perfil de trabajo en el caso de un dispositivo personal con perfil de trabajo. El borrado solo se produce una vez que el dispositivo confirma el comando. El comando se puede cancelar antes de ese momento. |
CommandErrorCode
Es un código de error de comando. Este es un campo de solo lectura que completa el servidor.
Enumeraciones | |
---|---|
COMMAND_ERROR_CODE_UNSPECIFIED |
No hubo error. |
UNKNOWN |
Se produjo un error desconocido. |
API_LEVEL |
El nivel de API del dispositivo no admite este comando. |
MANAGEMENT_MODE |
El modo de administración (propietario del perfil, propietario del dispositivo, etc.) no admite el comando. |
INVALID_VALUE |
El comando tiene un valor de parámetro no válido. |
UNSUPPORTED |
El dispositivo no admite el comando. Es posible que se resuelva el problema si actualizas la Política de dispositivos Android a la versión más reciente. |
ResetPasswordFlag
Son marcas que se pueden usar para el tipo de comando RESET_PASSWORD
.
Enumeraciones | |
---|---|
RESET_PASSWORD_FLAG_UNSPECIFIED |
Este valor se ignora. |
REQUIRE_ENTRY |
No permitas que otros administradores vuelvan a cambiar la contraseña hasta que el usuario la haya ingresado. |
DO_NOT_ASK_CREDENTIALS_ON_BOOT |
No solicites credenciales de usuario durante el inicio del dispositivo. |
LOCK_NOW |
Bloquea el dispositivo después de restablecer la contraseña. |
ClearAppsDataParams
Son los parámetros asociados al comando
para borrar los datos de las apps especificadas del dispositivo.CLEAR_APP_DATA
Representación JSON |
---|
{ "packageNames": [ string ] } |
Campos | |
---|---|
packageNames[] |
Son los nombres de paquete de las apps cuyos datos se borrarán cuando se ejecute el comando. |
StartLostModeParams
Son los parámetros asociados con el comando
para poner el dispositivo en modo perdido. Se debe proporcionar al menos uno de los parámetros, sin incluir el nombre de la organización, para que el dispositivo se ponga en modo perdido.START_LOST_MODE
Representación JSON |
---|
{ "lostMessage": { object ( |
Campos | |
---|---|
lostMessage |
Es el mensaje que se muestra al usuario cuando el dispositivo está en modo extraviado. |
lostPhoneNumber |
Número de teléfono al que se llamará cuando el dispositivo esté en modo de pérdida y se presione el botón del propietario de la llamada. |
lostEmailAddress |
Es la dirección de correo electrónico que se muestra al usuario cuando el dispositivo está en modo extraviado. |
lostStreetAddress |
Es la dirección que se muestra al usuario cuando el dispositivo está en modo extraviado. |
lostOrganization |
Es el nombre de la organización que se muestra al usuario cuando el dispositivo está en modo de pérdida. |
StopLostModeParams
Este tipo no tiene campos.
Son los parámetros asociados al comando
para sacar el dispositivo del modo extraviado.STOP_LOST_MODE
AddEsimParams
Parámetros asociados al comando
para agregar un perfil de eSIM al dispositivo.ADD_ESIM
Representación JSON |
---|
{
"activationCode": string,
"activationState": enum ( |
Campos | |
---|---|
activationCode |
Obligatorio. Es el código de activación del perfil de eSIM. |
activationState |
Obligatorio. Es el estado de activación del perfil de eSIM una vez que se descarga. |
ActivationState
Es el estado de activación del perfil de eSIM una vez que se descarga.
Enumeraciones | |
---|---|
ACTIVATION_STATE_UNSPECIFIED |
No se especificó el estado de activación de la eSIM. De forma predeterminada, el perfil de eSIM está en los dispositivos personales y en los dispositivos empresariales. |
ACTIVATED |
La eSIM se activa automáticamente después de la descarga. Si se establece este valor como el estado de activación para los dispositivos personales, se rechazará el comando. |
NOT_ACTIVATED |
Se descarga el perfil de eSIM, pero no se activa. En este caso, el usuario deberá activar la eSIM de forma manual en el dispositivo. |
RemoveEsimParams
Son los parámetros asociados al comando
para quitar un perfil de eSIM del dispositivo.REMOVE_ESIM
Representación JSON |
---|
{ "iccId": string } |
Campos | |
---|---|
iccId |
Obligatorio. ID de ICC del perfil de eSIM que se borrará. |
RequestDeviceInfoParams
Son los parámetros asociados al comando
para obtener información relacionada con el dispositivo.REQUEST_DEVICE_INFO
Representación JSON |
---|
{
"deviceInfo": enum ( |
Campos | |
---|---|
deviceInfo |
Obligatorio. Es el tipo de información del dispositivo que se solicitará. |
DeviceInfo
Es el tipo de información del dispositivo que se solicitará.
Enumeraciones | |
---|---|
DEVICE_INFO_UNSPECIFIED |
Este valor no está permitido. |
EID |
Solicita el identificador de la eSIM. Se le pedirá al usuario que apruebe la divulgación de la información antes de que se pueda mostrar el resultado. Si el usuario no aprueba la divulgación, se devolverá . Esta función solo es compatible con dispositivos personales que tienen perfiles de trabajo y versiones de Android 13 y posteriores. |
WipeParams
Son los parámetros asociados con el comando
para limpiar el dispositivo.WIPE
Representación JSON |
---|
{ "wipeDataFlags": [ enum ( |
Campos | |
---|---|
wipeDataFlags[] |
Opcional. Son marcas para determinar qué datos se deben borrar. |
wipeReason |
Opcional. Es un mensaje breve que se muestra al usuario antes de borrar el perfil de trabajo en dispositivos personales. Esto no tiene efecto en los dispositivos propiedad de la empresa. La longitud máxima del mensaje es de 200 caracteres. |
ClearAppsDataStatus
Es el estado del comando
para borrar los datos de las apps especificadas del dispositivo.CLEAR_APP_DATA
Representación JSON |
---|
{
"results": {
string: {
object ( |
Campos | |
---|---|
results |
Son los resultados por app, una asignación de nombres de paquetes al resultado de eliminación respectivo. Es un objeto que contiene una lista de pares |
PerAppResult
Es el resultado de un intento de borrar los datos de una sola app.
Representación JSON |
---|
{
"clearingResult": enum ( |
Campos | |
---|---|
clearingResult |
Es el resultado de un intento de borrar los datos de una sola app. |
ClearingResult
Es el resultado de un intento de borrar los datos de una sola app.
Enumeraciones | |
---|---|
CLEARING_RESULT_UNSPECIFIED |
Resultado no especificado. |
SUCCESS |
Se borraron correctamente los datos de esta app. |
APP_NOT_FOUND |
No se pudieron borrar los datos de esta app porque no se encontró. |
APP_PROTECTED |
No se pudieron borrar los datos de esta app porque está protegida. Por ejemplo, esto puede aplicarse a las apps fundamentales para el funcionamiento del dispositivo, como Google Play Store. |
API_LEVEL |
No se pudieron borrar los datos de esta app porque el nivel de API del dispositivo no admite este comando. |
StartLostModeStatus
Es el estado del comando
para poner el dispositivo en modo de pérdida.START_LOST_MODE
Representación JSON |
---|
{
"status": enum ( |
Campos | |
---|---|
status |
Es el estado. Consulta los |
Estado
Es el estado. Consulta los
.StartLostModeStatus
Enumeraciones | |
---|---|
STATUS_UNSPECIFIED |
Sin especificar. Este valor no se usa. |
SUCCESS |
Se activó el modo extraviado en el dispositivo. |
RESET_PASSWORD_RECENTLY |
No se pudo poner el dispositivo en modo extraviado porque el administrador restableció la contraseña del dispositivo recientemente. |
USER_EXIT_LOST_MODE_RECENTLY |
No se pudo activar el modo extraviado en el dispositivo porque el usuario salió de ese modo recientemente. |
ALREADY_IN_LOST_MODE |
El dispositivo ya está en modo extraviado. |
StopLostModeStatus
Es el estado del comando
para sacar el dispositivo del modo extraviado.STOP_LOST_MODE
Representación JSON |
---|
{
"status": enum ( |
Campos | |
---|---|
status |
Es el estado. Consulta los |
Estado
Es el estado. Consulta los
.StopLostModeStatus
Enumeraciones | |
---|---|
STATUS_UNSPECIFIED |
Sin especificar. Este valor no se usa. |
SUCCESS |
Se quitó el dispositivo del modo extraviado. |
NOT_IN_LOST_MODE |
El dispositivo no está en modo extraviado. |
EsimCommandStatus
Son los detalles de estado y error (si están presentes) de un comando
o ADD_ESIM
.REMOVE_ESIM
Representación JSON |
---|
{ "status": enum ( |
Campos | |
---|---|
status |
Solo salida. Es el estado de un comando |
esimInfo |
Solo salida. Es la información sobre la eSIM que se agregó o quitó. Este campo se propaga solo cuando la operación de eSIM |
Campo de unión status_details . Son los detalles del estado de un comando o . status_details solo puede ser uno de los siguientes: |
|
internalErrorDetails |
Solo salida. Son los detalles del error si |
Estado
Es el estado de un comando
o ADD_ESIM
.REMOVE_ESIM
Enumeraciones | |
---|---|
STATUS_UNSPECIFIED |
Sin especificar. Este valor no se usa. |
SUCCESS |
La operación de eSIM se realizó correctamente en el dispositivo. |
IN_PROGRESS |
La operación de eSIM está en curso. |
PENDING_USER_ACTION |
El usuario debe realizar una acción para que continúe la operación de la eSIM. |
ERROR_SETUP_IN_PROGRESS |
La operación de la eSIM no se puede ejecutar mientras la configuración está en curso. |
ERROR_USER_DENIED |
El usuario rechazó la operación de la eSIM. |
INTERNAL_ERROR |
Se produjo un error al intentar agregar o quitar la eSIM en el dispositivo. Consulta . |
ERROR_ICC_ID_NOT_FOUND |
En el caso de un comando , no se encontró el de la eSIM que se quitará en el dispositivo. Esto podría significar que la eSIM no pertenece a la empresa o que la eSIM correspondiente a no está presente en el dispositivo. |
ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT |
El comando falló cuando se intentó agregar una nueva eSIM con su estado de activación establecido en , ya que varias ranuras de eSIM en el dispositivo contienen perfiles de eSIM activos y no hay ninguna ranura de eSIM disponible. Para resolver este problema, la nueva eSIM se puede agregar con su estado de activación como para la activación manual posterior, o bien el usuario debe desactivar primero una eSIM activa existente para que la operación continúe. |
InternalErrorDetails
Son los detalles del error interno si están presentes para el comando
o ADD_ESIM
.REMOVE_ESIM
Representación JSON |
---|
{ "operationCode": string, "errorCode": string, "operationCodeDetail": enum ( |
Campos | |
---|---|
operationCode |
Solo salida. Representación numérica del código de operación, como se especifica aquí. Consulta |
errorCode |
Solo salida. Representación de número entero del código de error, como se especifica aquí. Consulta también |
operationCodeDetail |
Solo salida. Es el detalle del código de operación correspondiente a |
errorCodeDetail |
Solo salida. Es el detalle del código de error correspondiente a |
OperationCodeDetail
Es el detalle del código de operación correspondiente a
.operationCode
Enumeraciones | |
---|---|
OPERATION_CODE_DETAIL_UNSPECIFIED |
No se especifican detalles del código de operación. La API de Android Management no reconoce el . Sin embargo, consulta . |
OPERATION_SYSTEM |
Consulta EuiccManager.OPERATION_SYSTEM para obtener más detalles. |
OPERATION_SIM_SLOT |
Consulta EuiccManager.OPERATION_SIM_SLOT para obtener más detalles. |
OPERATION_EUICC_CARD |
Consulta EuiccManager.OPERATION_EUICC_CARD para obtener más detalles. |
OPERATION_SMDX |
Consulta EuiccManager.OPERATION_SMDX para obtener más información. |
OPERATION_SWITCH |
Consulta EuiccManager.OPERATION_SWITCH para obtener más detalles. |
OPERATION_DOWNLOAD |
Consulta EuiccManager.OPERATION_DOWNLOAD para obtener más detalles. |
OPERATION_METADATA |
Consulta EuiccManager.OPERATION_METADATA para obtener más detalles. |
OPERATION_EUICC_GSMA |
Consulta EuiccManager.OPERATION_EUICC_GSMA para obtener más información. |
OPERATION_APDU |
Consulta EuiccManager.OPERATION_APDU para obtener más detalles. |
OPERATION_SMDX_SUBJECT_REASON_CODE |
Consulta EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE para obtener más información. Ten en cuenta que, en este caso, son los 3 bytes menos significativos de EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE , que especifican el código de asunto y el código de motivo, como se indica aquí. El byte más significativo del número entero se establece en cero. Por ejemplo, un código de asunto de 8.11.1 y un código de motivo de 5.1 se representan en como 0000 0000 1000 1011 0001 0000 0101 0001 en binario, que es 9113681 en decimal. |
OPERATION_HTTP |
Consulta EuiccManager.OPERATION_HTTP para obtener más detalles. |
ErrorCodeDetail
Detalle del código de error correspondiente a
.errorCode
Enumeraciones | |
---|---|
ERROR_CODE_DETAIL_UNSPECIFIED |
No se especifican los detalles del código de error. La API de Android Management no reconoce el . Sin embargo, consulta
|
ERROR_TIME_OUT |
Consulta EuiccManager.ERROR_TIME_OUT para obtener más detalles. |
ERROR_EUICC_MISSING |
Consulta EuiccManager.ERROR_EUICC_MISSING para obtener más detalles. |
ERROR_UNSUPPORTED_VERSION |
Consulta EuiccManager.ERROR_UNSUPPORTED_VERSION para obtener más detalles. |
ERROR_ADDRESS_MISSING |
Consulta EuiccManager.ERROR_ADDRESS_MISSING para obtener más detalles. |
ERROR_INVALID_CONFIRMATION_CODE |
Consulta EuiccManager.ERROR_INVALID_CONFIRMATION_CODE para obtener más detalles. |
ERROR_CERTIFICATE_ERROR |
Consulta EuiccManager.ERROR_CERTIFICATE_ERROR para obtener más detalles. |
ERROR_NO_PROFILES_AVAILABLE |
Consulta EuiccManager.ERROR_NO_PROFILES_AVAILABLE para obtener más detalles. |
ERROR_CONNECTION_ERROR |
Consulta EuiccManager.ERROR_CONNECTION_ERROR para obtener más detalles. |
ERROR_INVALID_RESPONSE |
Consulta EuiccManager.ERROR_INVALID_RESPONSE para obtener más detalles. |
ERROR_CARRIER_LOCKED |
Consulta EuiccManager.ERROR_CARRIER_LOCKED para obtener más detalles. |
ERROR_DISALLOWED_BY_PPR |
Consulta EuiccManager.ERROR_DISALLOWED_BY_PPR para obtener más detalles. |
ERROR_INVALID_ACTIVATION_CODE |
Consulta EuiccManager.ERROR_INVALID_ACTIVATION_CODE para obtener más detalles. |
ERROR_INCOMPATIBLE_CARRIER |
Consulta EuiccManager.ERROR_INCOMPATIBLE_CARRIER para obtener más detalles. |
ERROR_OPERATION_BUSY |
Consulta EuiccManager.ERROR_OPERATION_BUSY para obtener más detalles. |
ERROR_INSTALL_PROFILE |
Consulta EuiccManager.ERROR_INSTALL_PROFILE para obtener más detalles. |
ERROR_EUICC_INSUFFICIENT_MEMORY |
Consulta EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY para obtener más detalles. |
ERROR_INVALID_PORT |
Consulta EuiccManager.ERROR_INVALID_PORT para obtener más detalles. |
ERROR_SIM_MISSING |
Consulta EuiccManager.ERROR_SIM_MISSING para obtener más detalles. |
EsimInfo
Son los detalles de la eSIM agregada o quitada.
Representación JSON |
---|
{ "iccId": string } |
Campos | |
---|---|
iccId |
Solo salida. Es el ID de ICC de la eSIM. |
RequestDeviceInfoStatus
Es el estado del comando
.REQUEST_DEVICE_INFO
Representación JSON |
---|
{ "status": enum ( |
Campos | |
---|---|
status |
Solo salida. Es el estado de un comando |
Campo de unión device_info . Son los detalles de la información del dispositivo que solicitó el administrador. Este campo solo se propaga cuando es . device_info solo puede ser uno de los siguientes: |
|
eidInfo |
Es información relacionada con los EIDs del dispositivo. |
Estado
Es el estado de un comando
.REQUEST_DEVICE_INFO
Enumeraciones | |
---|---|
STATUS_UNSPECIFIED |
Sin especificar. Este valor no se usa. |
SUCCEEDED |
Se entregó correctamente la información del dispositivo. |
PENDING_USER_ACTION |
El usuario no completó las acciones necesarias para compartir la información del dispositivo. |
USER_DECLINED |
El usuario rechazó compartir la información del dispositivo. |
UNSUPPORTED |
La información del dispositivo solicitada no es compatible con este dispositivo, p.ej., la eSIM no es compatible con el dispositivo. |
EidInfo
Es información relacionada con los EIDs del dispositivo.
Representación JSON |
---|
{
"eids": [
{
object ( |
Campos | |
---|---|
eids[] |
Solo salida. Es la información del EID de cada chip de la eUICC. |
Eid
Es la información del EID de cada chip de la eUICC.
Representación JSON |
---|
{ "eid": string } |
Campos | |
---|---|
eid |
Solo salida. El EID |