google_api_android_enterprise v0.1.0 GoogleApi.AndroidEnterprise.V1.Api.Devices View Source
API calls for all endpoints tagged Devices
.
Link to this section Summary
Functions
Retrieves the details of a device
Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users
Retrieves the IDs of all of a user's devices
Updates the device policy. This method supports patch semantics
Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users
Updates the device policy
Link to this section Functions
androidenterprise_devices_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Device.t()} | {:error, Tesla.Env.t()}
Retrieves the details of a device.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String.t): The ID of the enterprise.
- user_id (String.t): The ID of the user.
- device_id (String.t): The ID of the device.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Device{}} on success {:error, info} on failure
androidenterprise_devices_get_state( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.DeviceState.t()} | {:error, Tesla.Env.t()}
Retrieves whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String.t): The ID of the enterprise.
- user_id (String.t): The ID of the user.
- device_id (String.t): The ID of the device.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.DeviceState{}} on success {:error, info} on failure
androidenterprise_devices_list( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.DevicesListResponse.t()} | {:error, Tesla.Env.t()}
Retrieves the IDs of all of a user's devices.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String.t): The ID of the enterprise.
- user_id (String.t): The ID of the user.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.DevicesListResponse{}} on success {:error, info} on failure
androidenterprise_devices_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Device.t()} | {:error, Tesla.Env.t()}
Updates the device policy. This method supports patch semantics.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String.t): The ID of the enterprise.
- user_id (String.t): The ID of the user.
- device_id (String.t): The ID of the device.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :updateMask (String.t): Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=<field1>,<field2>,…
- :body (Device):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Device{}} on success {:error, info} on failure
androidenterprise_devices_set_state( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.DeviceState.t()} | {:error, Tesla.Env.t()}
Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users.
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String.t): The ID of the enterprise.
- user_id (String.t): The ID of the user.
- device_id (String.t): The ID of the device.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :body (DeviceState):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.DeviceState{}} on success {:error, info} on failure
androidenterprise_devices_update( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.Device.t()} | {:error, Tesla.Env.t()}
Updates the device policy
Parameters
- connection (GoogleApi.AndroidEnterprise.V1.Connection): Connection to server
- enterprise_id (String.t): The ID of the enterprise.
- user_id (String.t): The ID of the user.
- device_id (String.t): The ID of the device.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :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): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :updateMask (String.t): Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=<field1>,<field2>,…
- :body (Device):
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.Device{}} on success {:error, info} on failure