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)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  },
  "enterpriseType": enum (EnterpriseType),
  "managedGooglePlayAccountsEnterpriseType": enum (ManagedGooglePlayAccountsEnterpriseType),
  "managedGoogleDomainType": enum (ManagedGoogleDomainType)
}
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}. Esse 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 mostrada na interface do app de gerenciamento de dispositivos. Os componentes de cor são armazenados da seguinte forma: (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 aos 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 nessa lista.

appAutoApprovalEnabled
(deprecated)

boolean

Descontinuado e não usado.

signinDetails[]

object (SigninDetail)

Detalhes de login da empresa.

contactInfo

object (ContactInfo)

As informações de contato corporativo de uma empresa gerenciada por EMM.

googleAuthenticationSettings

object (GoogleAuthenticationSettings)

Configurações para autenticação de usuários fornecida pelo Google.

enterpriseType

enum (EnterpriseType)

Apenas saída. O tipo de empresa.

managedGooglePlayAccountsEnterpriseType

enum (ManagedGooglePlayAccountsEnterpriseType)

Apenas saída. O tipo de um pacote de contas do Google Play gerenciado.

managedGoogleDomainType

enum (ManagedGoogleDomainType)

Apenas saída. O tipo de domínio gerenciado do 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 é inscrito.
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 de dispositivo é concluído.
USAGE_LOGS Uma notificação enviada quando o dispositivo envia BatchUsageLogEvents.
ENTERPRISE_UPGRADE Uma notificação enviada para um upgrade corporativo. Um upgrade empresarial é um processo que atualiza um pacote de contas do Google Play gerenciado para um Managed Google Domain.

ExternalData

Dados hospedados em um local externo. Os dados precisam ser baixados pelo Android Device Policy e verificados com o hash.

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

string

O URL absoluto dos dados, que precisa usar o esquema http ou https. A Política de dispositivo Android não fornece credenciais na solicitação GET. Portanto, o URL precisa ser acessível publicamente. Incluir um componente longo e aleatório no URL pode ser usado 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 usará os dados.

TermsAndConditions

Uma página de Termos e Condições para 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 que contém detalhes de login para uma empresa. Use enterprises para gerenciar SigninDetails de uma determinada empresa.

Para uma empresa, podemos ter qualquer número de SigninDetails identificados de maneira exclusiva 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 vai retornar o mesmo signinEnrollmentToken e qrCode.
  • Se transmitirmos várias configurações SigninDetail idênticas que não estão armazenadas, a primeira delas será armazenada.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, um erro de chave duplicada será gerado e toda a operação vai falhar.
  • Se removermos determinada configuração SigninDetail da solicitação, ela será removida do armazenamento. Em seguida, 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 sem sucesso.

signinEnrollmentToken

string

Um token de inscrição em toda a empresa usado para acionar o fluxo de login 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 QR code e registrar um dispositivo com esse token de inscrição. Para registrar um dispositivo usando NFC, o registro NFC precisa conter uma representação serializada java.util.Properties 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 inscrição.

Para dispositivos da empresa:

  • Ao ativar o uso pessoal, o usuário pode configurar um perfil de trabalho no dispositivo.
  • Para desativar o uso pessoal, o usuário precisa provisionar o dispositivo como totalmente gerenciado.

Para dispositivos pessoais:

  • Ao ativar o uso pessoal, o usuário pode configurar um perfil de trabalho no dispositivo.
  • A desativação do uso pessoal impede o provisionamento do dispositivo. Não é possível desativar o uso pessoal 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 inscrição na Conta do Google. Apenas um dos signinDetails de uma empresa pode ter defaultStatus definido como SIGNIN_DETAIL_IS_DEFAULT. Se um Enterprise tiver pelo menos um signinDetails e nenhum deles tiver defaultStatus definido como SIGNIN_DETAIL_IS_DEFAULT, o primeiro da lista será selecionado e terá defaultStatus definido como SIGNIN_DETAIL_IS_DEFAULT. Se nenhum signinDetails for especificado para o Enterprise, o registro do dispositivo na Conta do Google vai falhar.

tokenTag

string

Metadados especificados pela 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 com contas gerenciadas do Google Play.

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 é validado, mas não verificado.

dataProtectionOfficerPhone

string

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

euRepresentativeName

string

O nome do representante da UE.

euRepresentativeEmail

string

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

euRepresentativePhone

string

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

GoogleAuthenticationSettings

Contém configurações para autenticação de usuários 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 admin de TI pode especificar se a autenticação do Google está ativada para a empresa em dispositivos de profissionais intelectuais. Esse valor só pode ser definido pelo Google Admin Console. A autenticação do Google pode ser usada com signinUrl. Caso ela seja obrigatória e um signinUrl seja especificado, a autenticação do Google será iniciada antes de signinUrl.

GoogleAuthenticationRequired

Configuração para determinar 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.

EnterpriseType

O tipo de empresa.

Enums
ENTERPRISE_TYPE_UNSPECIFIED Esse valor não é usado.
MANAGED_GOOGLE_DOMAIN A empresa pertence a um domínio gerenciado do Google.
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE A empresa é um pacote de contas do Google Play gerenciado.

ManagedGooglePlayAccountsEnterpriseType

O tipo de um pacote de contas do Google Play gerenciado.

Enums
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED O tipo de pacote de contas do Google Play gerenciado não foi especificado.
CUSTOMER_MANAGED A empresa é gerenciada pelo cliente
EMM_MANAGED A empresa é gerenciada por EMM (descontinuado).

ManagedGoogleDomainType

O tipo de domínio gerenciado do Google.

Enums
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED O tipo de domínio gerenciado do Google não foi especificado.
TYPE_TEAM O domínio gerenciado do Google é uma equipe com e-mail verificado.
TYPE_DOMAIN O domínio gerenciado do Google foi verificado.

Métodos

create

Cria uma empresa.

delete

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

generateEnterpriseUpgradeUrl

Gera um URL de upgrade empresarial para atualizar um pacote de contas do Google Play gerenciado para um Managed Google Domain.

get

Recebe uma empresa.

list

Lista as empresas gerenciadas por EMM.

patch

Atualiza uma empresa.