- 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
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- Estado
- StopLostModeStatus
- Estado
- Pruébalo
Emite un comando a un dispositivo. El recurso Operation
que se muestra contiene un Command
en su campo metadata
. Usa el método de operación de obtención 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 |
Es el 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 la descripción general de OAuth 2.0.
Comando
Un comando.
Representación JSON |
---|
{ "type": enum ( |
Campos | |
---|---|
type |
Es el tipo de comando. |
create |
Es la marca de tiempo en la que se creó el comando. El servidor genera la marca de tiempo automáticamente. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. 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 tiempo. Si no se especifica, la duración predeterminada 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 “ |
user |
Es el nombre de recurso del usuario propietario del dispositivo en el formato |
error |
Si el comando falla, se muestra un código de error que explica el error. Esto no se establece cuando el llamador cancela el comando. |
new |
Para los comandos de tipo |
reset |
Para los comandos de tipo |
Campo de unión Si se establece, no se deben establecer los campos |
|
clear |
Parámetros del comando |
start |
Parámetros para el comando |
stop |
Parámetros del 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: |
|
clear |
Solo salida. Estado del comando |
start |
Solo salida. Estado del comando |
stop |
Solo salida. Estado del comando |
CommandType
Tipos de comandos.
Enumeraciones | |
---|---|
COMMAND_TYPE_UNSPECIFIED |
Este valor no se permite. |
LOCK |
Bloquea el dispositivo, como si el tiempo de espera de la pantalla de bloqueo hubiera caducado. |
RESET_PASSWORD |
Restablece la contraseña del usuario. |
REBOOT |
Reinicia el dispositivo. Solo es compatible con 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 que pertenezca a la empresa, lo que permite que se use 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 el almacenamiento externo o en un diccionario de usuario. Consulta también . |
START_LOST_MODE |
Pone el dispositivo en modo perdido. Solo se admite en dispositivos completamente administrados o dispositivos 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 de la organización con un perfil administrado. Consulta también . |
CommandErrorCode
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 errores. |
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 solucione el problema si actualizas la Política de dispositivos de Android a la versión más reciente. |
ResetPasswordFlag
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
Parámetros asociados con el comando
para borrar los datos de apps especificadas del dispositivo.CLEAR_APP_DATA
Representación JSON |
---|
{ "packageNames": [ string ] } |
Campos | |
---|---|
package |
Los nombres de los paquetes de las apps cuyos datos se borrarán cuando se ejecute el comando. |
StartLostModeParams
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 entre en modo perdido.START_LOST_MODE
Representación JSON |
---|
{ "lostMessage": { object ( |
Campos | |
---|---|
lost |
Es el mensaje que se muestra al usuario cuando el dispositivo está en modo extraviado. |
lost |
Es el número de teléfono al que se llamará cuando el dispositivo esté en modo perdido y se presione el botón para llamar al propietario. |
lost |
Es la dirección de correo electrónico que se muestra al usuario cuando el dispositivo está en modo extraviado. |
lost |
Es la dirección que se muestra al usuario cuando el dispositivo está en modo extraviado. |
lost |
Es el nombre de la organización que se muestra al usuario cuando el dispositivo está en modo perdido. |
StopLostModeParams
Este tipo no tiene campos.
Parámetros asociados con el comando
para sacar el dispositivo del modo extraviadoSTOP_LOST_MODE
ClearAppsDataStatus
Estado del comando
para borrar los datos de apps especificadas del dispositivo.CLEAR_APP_DATA
Representación JSON |
---|
{
"results": {
string: {
object ( |
Campos | |
---|---|
results |
Los resultados por app, una asignación de nombres de paquetes al resultado de limpieza correspondiente 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 | |
---|---|
clearing |
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 apps esenciales 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 perdido.START_LOST_MODE
Representación JSON |
---|
{
"status": enum ( |
Campos | |
---|---|
status |
El estado. Consulta los |
Estado
El estado. Consulta los
.StartLostModeStatus
Enumeraciones | |
---|---|
STATUS_UNSPECIFIED |
Sin especificar. Este valor no se usa. |
SUCCESS |
El dispositivo se puso en modo extraviado. |
RESET_PASSWORD_RECENTLY |
No se pudo activar el modo extraviado en el dispositivo porque el administrador restableció la contraseña recientemente. |
USER_EXIT_LOST_MODE_RECENTLY |
No se pudo activar el modo extraviado en el dispositivo porque el usuario salió de este modo recientemente. |
ALREADY_IN_LOST_MODE |
El dispositivo ya está en modo extraviado. |
StopLostModeStatus
Estado del comando
para sacar el dispositivo del modo extraviado.STOP_LOST_MODE
Representación JSON |
---|
{
"status": enum ( |
Campos | |
---|---|
status |
El estado. Consulta los |
Estado
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. |