REST Resource: enterprises

Recurso: Enterprise

A configuração aplicada a uma empresa.

Representação JSON
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": integer,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ],
  "contactInfo": {
    object (ContactInfo)
  }
}
Campos
name

string

O nome da empresa gerado pelo servidor durante a criação, no formato enterprises/{enterpriseId}.

enabledNotificationTypes[]

enum (NotificationType)

Os tipos de notificações do Google Pub/Sub ativados para a empresa.

pubsubTopic

string

O tópico em que as notificações do Pub/Sub são publicadas, no formato projects/{project}/topics/{topic}. Este campo só é obrigatório se as notificações do Pub/Sub estiverem ativadas.

primaryColor

integer

Uma cor no formato RGB que indica a cor predominante a ser exibida na interface do app de gerenciamento de dispositivos. Os componentes de cor são armazenados da seguinte maneira: (red << 16) | (green << 8) | blue, em que o valor de cada componente está entre 0 e 255, inclusive.

enterpriseDisplayName

string

O nome da empresa exibido para os usuários. Esse campo tem um comprimento máximo de 100 caracteres.

termsAndConditions[]

object (TermsAndConditions)

Termos e Condições que precisam ser aceitos ao provisionar um dispositivo para esta empresa. Uma página de termos é gerada para cada valor nessa lista.

appAutoApprovalEnabled
(deprecated)

boolean

Obsoleto e não usado.

signinDetails[]

object (SigninDetail)

Detalhes de login da empresa.

contactInfo

object (ContactInfo)

Os dados de contato de uma empresa gerenciada pelo EMM.

NotificationType

Tipos de notificações que o servidor de gerenciamento de dispositivos pode enviar pelo Google Pub/Sub.

Enums
NOTIFICATION_TYPE_UNSPECIFIED Esse valor é ignorado.
ENROLLMENT Notificação enviada quando um dispositivo é registrado.
COMPLIANCE_REPORT

Obsoleto.

STATUS_REPORT Uma notificação enviada quando um dispositivo emite um relatório de status.
COMMAND Uma notificação enviada quando um comando do dispositivo é concluído.
USAGE_LOGS Uma notificação enviada quando o dispositivo envia BatchUsageLogEvents.

ExternalData

Dados hospedados em um local externo. O download dos dados será feito pelo Android Device Policy e comparado com o hash.

Representação JSON
{
  "url": string,
  "sha256Hash": string
}
Campos
url

string

O URL absoluto para os dados, que deve usar o esquema http ou https. O Android Device Policy não fornece credenciais na solicitação GET, então o URL precisa estar acessível publicamente. A inclusão de um componente longo e aleatório no URL pode ser usada para evitar que os atacantes descubram o URL.

sha256Hash

string

O hash SHA-256 codificado em base64 do conteúdo hospedado no URL. Se o conteúdo não corresponder a esse hash, o Android Device Policy não usará os dados.

TermsAndConditions

Uma página de Termos e Condições a ser aceita durante o provisionamento.

Representação JSON
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
Campos
header

object (UserFacingMessage)

Um cabeçalho curto que aparece acima do conteúdo HTML.

content

object (UserFacingMessage)

Uma string HTML bem formatada. Ela será analisada no cliente com android.text.HTML#fromHTML.

SigninDetail

Um recurso com detalhes de login para uma empresa. Use enterprises para gerenciar SigninDetails para uma determinada empresa.

Para uma empresa, podemos ter qualquer número de SigninDetails identificados exclusivamente pela combinação dos três campos a seguir (signinUrl, allowPersonalUsage, tokenTag). Não é possível criar dois SigninDetails com o mesmo (signinUrl, allowPersonalUsage, tokenTag) (tokenTag é um campo opcional).

Patch: a operação atualiza a lista atual de SigninDetails com a nova lista de SigninDetails.

  • Se a configuração SigninDetail armazenada for transmitida, ela retornará os mesmos signinEnrollmentToken e qrCode.
  • Se transmitirmos várias configurações de SigninDetail idênticas que não são armazenadas, ela vai armazenar a primeira entre essas configurações de SigninDetail.
  • Se a configuração já existir, não será possível solicitá-la mais de uma vez em uma chamada de API de patch específica. Caso contrário, ocorrerá um erro de chave duplicada e toda a operação falhará.
  • Se removermos determinada configuração de SigninDetail da solicitação, ela será removida do armazenamento. Podemos solicitar outros signinEnrollmentToken e qrCode para a mesma configuração de SigninDetail.
Representação JSON
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "tokenTag": string
}
Campos
signinUrl

string

URL de login para autenticação quando o dispositivo é provisionado com um token de registro de login. O endpoint de login precisa finalizar o fluxo de autenticação com um URL no formato https://enterprise.google.com/android/enroll?et= para um login bem-sucedido ou https://enterprise.google.com/android/enroll/invalid para um login com falha.

signinEnrollmentToken

string

Um token de registro para toda a empresa usado para acionar o fluxo de login personalizado. Este é um campo somente leitura gerado pelo servidor.

qrCode

string

É uma string JSON com representação UTF-8 que pode ser usada para gerar um QR code e registrar um dispositivo com esse token. Para registrar um dispositivo usando NFC, o registro NFC precisa conter uma representação java.util.Properties serializada das propriedades no JSON. Este é um campo somente leitura gerado pelo servidor.

allowPersonalUsage

enum (AllowPersonalUsage)

Controla se o uso pessoal é permitido em um dispositivo provisionado com esse token de registro.

Para dispositivos da empresa:

  • A ativação do uso pessoal permite que o usuário configure um perfil de trabalho no dispositivo.
  • Para desativar o uso pessoal, o usuário precisa provisionar o dispositivo como totalmente gerenciado.

Para dispositivos pessoais:

  • A ativação do uso pessoal permite que o usuário configure um perfil de trabalho no dispositivo.
  • A desativação do uso pessoal impedirá o provisionamento do dispositivo. O uso pessoal não pode ser desativado em um dispositivo pessoal.
tokenTag

string

Um metadados especificados pelo EMM para distinguir entre instâncias de SigninDetail.

ContactInfo

Detalhes de contato para empresas do Google Play gerenciado.

Representação JSON
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
Campos
contactEmail

string

Endereço de e-mail de um ponto de contato, que será usado para enviar avisos importantes relacionados ao Google Play gerenciado.

dataProtectionOfficerName

string

O nome do oficial de proteção de dados.

dataProtectionOfficerEmail

string

O e-mail do oficial de proteção de dados. O e-mail foi validado, mas não verificado.

dataProtectionOfficerPhone

string

O número de telefone do oficial de proteção de dados O número de telefone está validado, mas não foi verificado.

euRepresentativeName

string

O nome do representante da UE.

euRepresentativeEmail

string

O e-mail do representante da UE. O e-mail foi validado, mas não verificado.

euRepresentativePhone

string

O número de telefone do representante da UE. O número de telefone está validado, mas não verificado.

Métodos

create

Cria uma empresa.

delete

Exclui permanentemente uma empresa e todas as contas e dados associados a ela.

get

Recebe uma empresa.

list

Lista as empresas gerenciadas por EMM.

patch

Atualiza uma empresa.