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)
  }
}
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}. Esse campo só será 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 desta 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 esta 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 de uma empresa gerenciada pelo EMM.

googleAuthenticationSettings

object (GoogleAuthenticationSettings)

Configurações da autenticação de 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. O download dos dados será feito pelo Android Device Policy e verificados em relação ao hash.

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

string

O URL absoluto para os dados, que precisa usar o esquema http ou https. Como o Android Device Policy não fornece credenciais na solicitação GET, o URL precisa ser acessível publicamente. Incluir um componente longo e aleatório no URL pode ser usado para impedir que invasores o descubram.

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. Ele será analisado no cliente com android.text.HTML#fromHTML.

SigninDetail

Um recurso que contém detalhes de login de uma empresa. Use enterprises para gerenciar SigninDetails de 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 idênticas de SigninDetail que não estão armazenadas, a primeira entre essas configurações de SigninDetail será armazenada.
  • 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 determinadas configurações do SigninDetail da solicitação, ela será removida do armazenamento. Podemos solicitar outro signinEnrollmentToken e qrCode para a mesma configuração de 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 deve concluir o fluxo de autenticação com um URL no formato https://enterprise.google.com/android/enroll?et= para o 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 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 de registro. 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.
  • A desativação do uso pessoal exige que o usuário provisione o dispositivo como um dispositivo 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 dispositivos pessoais.
defaultStatus

enum (SigninDetailDefaultStatus)

Opcional. Define 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 no método de inscrição da Conta do Google. Apenas um dos 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 definido como SIGNIN_DETAIL_IS_DEFAULT, a primeira da lista vai ser selecionada e definir defaultStatus como SIGNIN_DETAIL_IS_DEFAULT. Se nenhum signinDetails foi especificado para o Enterprise, o registro do dispositivo da Conta do Google vai falhar.

tokenTag

string

Um metadado especificado pelo EMM para distinguir entre instâncias de SigninDetail.

SigninDetailDefaultStatus

Define 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 pacotes 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 vai ser usado para enviar anúncios 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 foi 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 foi validado, mas não verificado.

GoogleAuthenticationSettings

Contém configurações para autenticação de 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 na empresa para dispositivos de profissionais intelectuais. Esse valor só pode ser definido no Google Admin Console. A autenticação do Google pode ser usada com signinUrl. Caso a autenticação do Google seja necessária e um signinUrl seja especificado, a autenticação do Google será iniciada antes de signinUrl.

GoogleAuthenticationRequired

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

Enums
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED Esse valor não é usado.
NOT_REQUIRED A autenticação do Google não é obrigató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.