REST Resource: enterprises

Recurso: empresa

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)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  }
}
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 ativadas 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 é obrigatório apenas 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.

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 essa empresa. Uma página de termos é gerada para cada valor dessa lista.

appAutoApprovalEnabled
(deprecated)

boolean

Descontinuado e não usado.

signinDetails[]

object (SigninDetail)

Detalhes de login da empresa.

contactInfo

object (ContactInfo)

Os dados de contato da empresa gerenciada por EMM.

googleAuthenticationSettings

object (GoogleAuthenticationSettings)

Configurações para a autenticação do usuário fornecida pelo Google.

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 Uma 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. Os dados serão transferidos por download pelo Android Device Policy e verificados em relação ao hash.

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

string

O URL absoluto dos dados, que precisa usar o esquema http ou https. O Android Device Policy não fornece credenciais na solicitação GET. Portanto, o URL precisa ser acessível publicamente. A inclusão de um componente longo e aleatório no URL pode ser usada para impedir que invasores 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 vai 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. Ele será analisado no cliente com android.text.Html#fromHtml.

SigninDetail

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

Em uma empresa, podemos ter qualquer número de SigninDetails identificados de forma exclusiva pela combinação dos três campos a seguir (signinUrl, allowPersonalUsage e tokenTag). Não é possível criar dois SigninDetails com os mesmos valores (signinUrl, allowPersonalUsage e tokenTag). O 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 vai retornar o mesmo signinEnrollmentToken e qrCode.
  • Se transmitirmos várias configurações SigninDetail idênticas que não são armazenadas, a primeira será armazenada entre essas configurações 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, vai ocorrer um erro de chave duplicada e toda a operação vai falhar.
  • Se removermos uma determinada configuração SigninDetail da solicitação, ela será removida do armazenamento. Podemos solicitar outro signinEnrollmentToken e qrCode para a mesma configuração SigninDetail.
Representação JSON
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "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 concluir 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 em toda a empresa usado para acionar o fluxo de entrada personalizado. Este é um campo somente leitura gerado pelo servidor.

qrCode

string

Uma string JSON cuja representação UTF-8 pode ser usada para gerar um código QR para registrar um dispositivo com esse token de registro. Para registrar um dispositivo usando NFC, o registro de 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:

  • Ativar o 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:

  • Ativar o uso pessoal permite que o usuário configure um perfil de trabalho no dispositivo.
  • A desativação do uso pessoal impede o provisionamento do dispositivo. O uso pessoal não pode ser desativado em dispositivos de propriedade pessoal.
defaultStatus

enum (SigninDetailDefaultStatus)

Opcional. Indica se o URL de login deve ser usado por padrão para a empresa. O SigninDetail com defaultStatus definido como SIGNIN_DETAIL_IS_DEFAULT é usado para o método de registro da Conta do Google. Apenas uma das signinDetails de uma empresa pode ter defaultStatus definido como SIGNIN_DETAIL_IS_DEFAULT. Se uma Enterprise tiver pelo menos uma signinDetails e nenhuma delas tiver defaultStatus definida como SIGNIN_DETAIL_IS_DEFAULT, a primeira da lista será selecionada e definirá defaultStatus como SIGNIN_DETAIL_IS_DEFAULT. Se não houver signinDetails especificado para o Enterprise, a inscrição do dispositivo na Conta do Google vai falhar.

tokenTag

string

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

SigninDetailDefaultStatus

Indica se o URL de login deve ser usado por padrão para a empresa.

Enums
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED É equivalente a SIGNIN_DETAIL_IS_NOT_DEFAULT.
SIGNIN_DETAIL_IS_DEFAULT O URL de login será usado por padrão para a empresa.
SIGNIN_DETAIL_IS_NOT_DEFAULT O URL de login não será usado por padrão para a empresa.

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 foi verificado.

dataProtectionOfficerPhone

string

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

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 foi verificado.

euRepresentativePhone

string

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

GoogleAuthenticationSettings

Contém configurações para a autenticação do usuário fornecida pelo Google.

Representação JSON
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
Campos
googleAuthenticationRequired

enum (GoogleAuthenticationRequired)

Apenas saída. Indica se os usuários precisam ser autenticados pelo Google durante o processo de inscrição. O administrador de TI pode especificar se a Autenticação do Google está ativada para a empresa nos dispositivos de profissionais intelectuais. Esse valor só pode ser definido pelo Google Admin Console. A autenticação do Google pode ser usada com signinUrl. Quando a autenticação do Google é necessária e um signinUrl é especificado, ela é iniciada antes de signinUrl.

GoogleAuthenticationRequired

Configura se a autenticação do Google é necessária para essa empresa.

Enums
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED Esse valor não é usado.
NOT_REQUIRED A autenticação do Google não é necessária.
REQUIRED O usuário precisa ser autenticado pelo Google.

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.