google_api_android_device_provisioning v0.7.0 GoogleApi.AndroidDeviceProvisioning.V1.Api.Customers View Source

API calls for all endpoints tagged Customers.

Link to this section Summary

Functions

Creates a new configuration. Once created, a customer can apply the configuration to devices.

Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.

Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.

Unclaims a device from a customer and removes it from zero-touch enrollment.

Lists the DPCs (device policy controllers) that support zero-touch enrollment.

Link to this section Functions

Link to this function

androiddeviceprovisioning_customers_configurations_create(connection, parent, optional_params \\ [], opts \\ []) View Source

Creates a new configuration. Once created, a customer can apply the configuration to devices.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer that manages the configuration. An API resource name in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_configurations_delete(connection, name, optional_params \\ [], opts \\ []) View Source

Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • name (String.t): Required. The configuration to delete. An API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. If the configuration is applied to any devices, the API call fails.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_configurations_get(connection, name, optional_params \\ [], opts \\ []) View Source

Gets the details of a configuration.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • name (String.t): Required. The configuration to get. An API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_configurations_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Lists a customer's configurations.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer that manages the listed configurations. An API resource name in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListConfigurationsResponse{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_configurations_patch(connection, name, optional_params \\ [], opts \\ []) View Source

Updates a configuration's field values.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • name (String.t): Output only. The API resource name in the format customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Assigned by the server.
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (String.t): Required. The field mask applied to the target Configuration before

updating the fields. To learn more about using field masks, read FieldMask in the Protocol Buffers documentation.

  • :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_devices_apply_configuration(connection, parent, optional_params \\ [], opts \\ []) View Source

Applies a Configuration to the device to register the device for zero-touch enrollment. After applying a configuration to a device, the device automatically provisions itself on first boot, or next factory reset.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer managing the device. An API resource name in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerApplyConfigurationRequest.t):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_devices_get(connection, name, optional_params \\ [], opts \\ []) View Source

Gets the details of a device.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • name (String.t): Required. The device to get. An API resource name in the format customers/[CUSTOMER_ID]/devices/[DEVICE_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Device{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_devices_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Lists a customer's devices.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer managing the devices. An API resource name in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (String.t): The maximum number of devices to show in a page of results.

Must be between 1 and 100 inclusive.

  • :pageToken (String.t): A token specifying which result page to return.

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDevicesResponse{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_devices_remove_configuration(connection, parent, optional_params \\ [], opts \\ []) View Source

Removes a configuration from device.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer managing the device in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerRemoveConfigurationRequest.t):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_devices_unclaim(connection, parent, optional_params \\ [], opts \\ []) View Source

Unclaims a device from a customer and removes it from zero-touch enrollment.

After removing a device, a customer must contact their reseller to register the device into zero-touch enrollment again.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer managing the device. An API resource name in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :body (GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerUnclaimDeviceRequest.t):

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_dpcs_list(connection, parent, optional_params \\ [], opts \\ []) View Source

Lists the DPCs (device policy controllers) that support zero-touch enrollment.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • parent (String.t): Required. The customer that can use the DPCs in configurations. An API resource name in the format customers/[CUSTOMER_ID].
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDpcsResponse{}} on success {:error, info} on failure

Link to this function

androiddeviceprovisioning_customers_list(connection, optional_params \\ [], opts \\ []) View Source

Lists the user's customer accounts.

Parameters

  • connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
  • optional_params (keyword()): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (integer()): The maximum number of customers to show in a page of results.

A number between 1 and 100 (inclusive).

  • :pageToken (String.t): A token specifying which result page to return.

Returns

{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListCustomersResponse{}} on success {:error, info} on failure