GOgoogle
customers

GET /v1/customers/{customersId}/configurations/{configurationsId}

Gets the details of a configuration.

Request

  • Base URL
    https://androiddeviceprovisioning.googleapis.com
  • URL
    https://androiddeviceprovisioning.googleapis.com/v1/customers/{customersId}/configurations/{configurationsId}
  • Auth
    none declared

Path parameters

customersIdstring required
configurationsIdstring required

Response

Successful response

companyNamestring

Required. The name of the organization. Zero-touch enrollment shows this organization name to device users during device provisioning.

configurationIdstring int64

Output only. The ID of the configuration. Assigned by the server.

configurationNamestring

Required. A short name that describes the configuration's purpose. For example, Sales team or Temporary employees. The zero-touch enrollment portal displays this name to IT admins.

contactEmailstring

Required. The email address that device users can contact to get help. Zero-touch enrollment shows this email address to device users before device provisioning. The value is validated on input.

contactPhonestring

Required. The telephone number that device users can call, using another device, to get help. Zero-touch enrollment shows this number to device users before device provisioning. Accepts numerals, spaces, the plus sign, hyphens, and parentheses.

customMessagestring

A message, containing one or two sentences, to help device users get help or give them more details about what’s happening to their device. Zero-touch enrollment shows this message before the device is provisioned.

dpcExtrasstring

The JSON-formatted EMM provisioning extras that are passed to the DPC.

dpcResourcePathstring

Required. The resource name of the selected DPC (device policy controller) in the format customers/[CUSTOMER_ID]/dpcs/*. To list the supported DPCs, call customers.dpcs.list.

forcedResetTimestring google-duration

Optional. The timeout before forcing factory reset the device if the device doesn't go through provisioning in the setup wizard, usually due to lack of network connectivity during setup wizard. Ranges from 0-6 hours, with 2 hours being the default if unset.

isDefaultboolean

Required. Whether this is the default configuration that zero-touch enrollment applies to any new devices the organization purchases in the future. Only one customer configuration can be the default. Setting this value to true, changes the previous default configuration's isDefault value to false.

namestring

Output only. The API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Assigned by the server.

Changes

No recorded changes to this operation across all 4 revisions of this API.