REST Resource: customers.configurations

Recurso: Configuration

Uma configuração coleta as opções de provisionamento para dispositivos Android. Cada configuração combina:

  • O controlador de política do dispositivo (DPC) do EMM instalado nos dispositivos.
  • Políticas de EMM aplicadas nos dispositivos.
  • Metadados exibidos no dispositivo para ajudar os usuários durante a configuração.

Os clientes podem adicionar quantas configurações forem necessárias. No entanto, o registro sem toque funciona melhor quando um cliente define uma configuração padrão que é aplicada a novos dispositivos adquiridos pela organização.

Representação JSON
{
  "name": string,
  "configurationId": string,
  "configurationName": string,
  "dpcResourcePath": string,
  "dpcExtras": string,
  "companyName": string,
  "contactEmail": string,
  "contactPhone": string,
  "customMessage": string,
  "isDefault": boolean,
  "forcedResetTime": string
}
Campos
name

string

Apenas saída. O nome do recurso da API no formato customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Atribuído pelo servidor.

configurationId

string (int64 format)

Apenas saída. O ID da configuração. Atribuído pelo servidor.

configurationName

string

Obrigatório. Um nome curto que descreve a finalidade da configuração. Por exemplo, Equipe de vendas ou Funcionários temporários. O portal de registro sem toque exibe esse nome para os administradores de TI.

dpcResourcePath

string

Obrigatório. O nome do recurso do DPC selecionado (controlador de política do dispositivo) no formato customers/[CUSTOMER_ID]/dpcs/*. Para listar os DPCs compatíveis, chame customers.dpcs.list.

dpcExtras

string

Os extras de provisionamento de EMM formatados em JSON que são transmitidos para o DPC.

companyName

string

Obrigatório. É o nome da organização. O registro sem toque mostra o nome da organização para os usuários durante o provisionamento de dispositivo.

contactEmail

string

Obrigatório. O endereço de e-mail com que os usuários do dispositivo podem entrar em contato para receber ajuda. O registro sem toque mostra esse endereço de e-mail para os usuários antes do provisionamento de dispositivo. O valor é validado na entrada.

contactPhone

string

Obrigatório. O número de telefone que os usuários podem ligar usando outro dispositivo para receber ajuda. O registro sem toque mostra esse número para os usuários antes do provisionamento de dispositivo. Aceita números, espaços, o sinal de adição, hifens e parênteses.

customMessage

string

Uma mensagem com uma ou duas frases para ajudar os usuários do dispositivo a receber ajuda ou dar mais detalhes sobre o que está acontecendo com o dispositivo. O registro sem toque mostrará essa mensagem antes do provisionamento de dispositivo.

isDefault

boolean

Obrigatório. Se esta é a configuração padrão que o registro sem toque aplica a todos os novos dispositivos que a organização comprar no futuro. Apenas uma configuração do cliente pode ser o padrão. Definir esse valor como true altera o valor isDefault da configuração padrão anterior para false.

forcedResetTime

string (Duration format)

Opcional. O tempo limite antes de forçar o dispositivo a restaurar a configuração original se o dispositivo não passar pelo provisionamento no assistente de configuração, geralmente devido à falta de conectividade de rede durante o assistente de configuração. Varia de 0 a 6 horas, sendo 2 horas o padrão se não definido.

Uma duração em segundos com até nove dígitos fracionários, terminando com "s". Exemplo: "3.5s".

Métodos

create

Cria uma nova configuração.

delete

Exclui uma configuração não utilizada.

get

Recebe os detalhes de uma configuração.

list

Lista as configurações de um cliente.

patch

Atualiza os valores de campo de uma configuração.