google_api_android_device_provisioning v0.1.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
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
Link to this section Functions
androiddeviceprovisioning_customers_configurations_create( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :body (Configuration):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_configurations_delete( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
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.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_configurations_list( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListConfigurationsResponse.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListConfigurationsResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_configurations_patch( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration.t()} | {:error, Tesla.Env.t()}
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.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :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 (Configuration):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Configuration{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_devices_apply_configuration( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :body (CustomerApplyConfigurationRequest):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_devices_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Device.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Device{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_devices_list( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDevicesResponse.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :pageToken (String.t): A token specifying which result page to return.
- :pageSize (String.t): The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDevicesResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_devices_remove_configuration( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :body (CustomerRemoveConfigurationRequest):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_devices_unclaim( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :body (CustomerUnclaimDeviceRequest):
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.Empty{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_dpcs_list( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDpcsResponse.t()} | {:error, Tesla.Env.t()}
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]`.
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
Returns
{:ok, %GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListDpcsResponse{}} on success {:error, info} on failure
androiddeviceprovisioning_customers_list(Tesla.Env.client(), keyword()) :: {:ok, GoogleApi.AndroidDeviceProvisioning.V1.Model.CustomerListCustomersResponse.t()} | {:error, Tesla.Env.t()}
Lists the user's customer accounts.
Parameters
- connection (GoogleApi.AndroidDeviceProvisioning.V1.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :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.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :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