GoogleApi.AndroidDeviceProvisioning.V1.Api.Customers (google_api_android_device_provisioning v0.20.2)
View SourceAPI calls for all endpoints tagged Customers.
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.
Gets the details of a configuration.
Lists a customer's configurations.
Updates a configuration's field values.
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.
Gets the details of a device.
Lists a customer's devices.
Removes a configuration from device.
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.
Lists the DPCs (device policy controllers) that support zero-touch enrollment.
Lists the user's customer accounts.
Functions
@spec androiddeviceprovisioning_customers_configurations_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new configuration. Once created, a customer can apply the configuration to devices.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer that manages the configuration. An API resource name in the formatcustomers/[CUSTOMER_ID]. This field has custom validation in CreateConfigurationRequestValidator -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_configurations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an unused configuration. The API call fails if the customer has devices with the configuration applied.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The configuration to delete. An API resource name in the formatcustomers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. If the configuration is applied to any devices, the API call fails. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_configurations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the details of a configuration.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The configuration to get. An API resource name in the formatcustomers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_configurations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListConfigurationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists a customer's configurations.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer that manages the listed configurations. An API resource name in the formatcustomers/[CUSTOMER_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListConfigurationsResponse{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_configurations_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a configuration's field values.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
name(type:String.t) - Output only. The API resource name in the formatcustomers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]. Assigned by the server. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask(type:String.t) - Required. The field mask applied to the targetConfigurationbefore updating the fields. To learn more about using field masks, read FieldMask in the Protocol Buffers documentation. -
:body(type:GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_devices_apply_configuration( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer managing the device. An API resource name in the formatcustomers/[CUSTOMER_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerApplyConfigurationRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_devices_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Device.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the details of a device.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
name(type:String.t) - Required. The device to get. An API resource name in the formatcustomers/[CUSTOMER_ID]/devices/[DEVICE_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Device{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_devices_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDevicesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists a customer's devices.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer managing the devices. An API resource name in the formatcustomers/[CUSTOMER_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:String.t) - Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. -
:pageToken(type:String.t) - A token specifying which result page to return.
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDevicesResponse{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_devices_remove_configuration( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Removes a configuration from device.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer managing the device in the formatcustomers/[CUSTOMER_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerRemoveConfigurationRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_devices_unclaim( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer managing the device. An API resource name in the formatcustomers/[CUSTOMER_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:body(type:GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerUnclaimDeviceRequest.t) -
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_dpcs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDpcsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the DPCs (device policy controllers) that support zero-touch enrollment.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
parent(type:String.t) - Required. The customer that can use the DPCs in configurations. An API resource name in the formatcustomers/[CUSTOMER_ID]. -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDpcsResponse{}}on success -
{:error, info}on failure
@spec androiddeviceprovisioning_customers_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListCustomersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the user's customer accounts.
Parameters
-
connection(type:GoogleApi.AndroidDeviceProvisioning.V1.Connection.t) - Connection to server -
optional_params(type:keyword()) - Optional parameters-
:"$.xgafv"(type:String.t) - V1 error format. -
:access_token(type:String.t) - OAuth access token. -
:alt(type:String.t) - Data format for response. -
:callback(type:String.t) - JSONP -
:fields(type:String.t) - Selector specifying which fields to include in a partial response. -
:key(type: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(type:String.t) - OAuth 2.0 token for the current user. -
:prettyPrint(type:boolean()) - Returns response with indentations and line breaks. -
:quotaUser(type: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(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize(type:integer()) - Required. The maximum number of customers to show in a page of results. A number between 1 and 100 (inclusive). -
:pageToken(type:String.t) - A token specifying which result page to return. This field has custom validations in ListCustomersRequestValidator
-
-
opts(type:keyword()) - Call options
Returns
-
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListCustomersResponse{}}on success -
{:error, info}on failure